予定を登録する API です。 リクエストで送信する EventType 型パラメーターには id、version といった更新時に必要なパラメーターもありますが、この API は新規作成のため、それぞれ「dummy」や「-1」など無効なことを表す値を指定してください。
ScheduleAddEvents
使用可能なGaroonのバージョン
固定リンクがコピーされました
クラウド版 Garoon
パッケージ版 Garoon 3.0 以降
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<parameters>
<schedule_event
xmlns=""
id="dummy"
event_type="normal"
version="dummy"
public_type="public"
plan="打合"
detail="新製品について"
description="新製品についての打合せです"
timezone="Asia/Tokyo"
end_timezone="Asia/Tokyo"
allday="true"
start_only="false" >
<members>
<member>
<user id="1" ></user>
</member>
<member>
<user id="2" ></user>
</member>
</members>
<when>
<datetime start="2010-07-04T09:00:00" end="2010-07-04T10:00:00" ></datetime>
</when>
</schedule_event>
</parameters>
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<returns>
<schedule_event
id="46988"
event_type="normal"
public_type="public"
plan="打合"
detail="新製品について"
description="新製品についての打合せです"
version="1278033362"
timezone="Asia/Tokyo"
end_timezone="Asia/Tokyo"
allday="false"
start_only="false" >
<members xmlns="http://schemas.cybozu.co.jp/schedule/2008" >
<member>
<user id="1" name="佐藤 太郎" order="0" />
</member>
<member>
<user id="2" name="萩澤 淳平" order="1" />
</member>
</members>
<when xmlns="http://schemas.cybozu.co.jp/schedule/2008" >
<datetime start="2010-07-04T09:00:00Z" end="2010-07-04T10:00:00Z" />
</when>
</schedule_event>
</returns>
エラー番号
説明
GRN_UTIL_API_65009
アップロードするファイルのサイズが、Base64 エンコード後で300MBより大きい場合
GRN_SCHD_13011
開始と終了の日時のデータの組み合わせが正しくない場合 クラウド版およびパッケージ版 Garoon 6.0 以降で発生するエラー番号です。 パッケージ版 Garoon 6.0 より前では、PHP00099 エラーが発生します。
登録した予定を修正する API です。この API は、入力した予定 ID を元に予定を特定して変更します。 リクエストの内容で、予定の情報が上書きされます。指定を省いた項目は、空になります。 予定のコメントの追加には、ScheduleAddFollows を使用します。この API では追加できません。
ScheduleModifyEvents
使用可能なGaroonのバージョン
固定リンクがコピーされました
クラウド版 Garoon
パッケージ版 Garoon 3.0 以降
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<parameters >
<schedule_event xmlns="" id="72"
event_type="normal" version="123"
public_type="public" timezone="Asia/Tokyo"
allday="false" start_only="false" >
<members>
<member>
<user id="6" order="1" ></user>
</member>
</members>
<when>
<datetime start="2010-07-09T02:00:00Z" end="2010-07-09T04:00:00Z" >
</datetime>
</when>
</schedule_event>
</parameters>
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<returns>
<schedule_event id="72"
event_type="normal"
public_type="public"
version="1278567340"
timezone="Asia/Tokyo"
allday="false"
start_only="false" >
<members xmlns="http://schemas.cybozu.co.jp/schedule/2008" >
<member>
<user id="6" name="佐藤 昇" order="0" />
</member>
</members>
<when xmlns="http://schemas.cybozu.co.jp/schedule/2008" >
<datetime start="2010-07-09T02:00:00Z" end="2010-07-09T04:00:00Z" />
</when>
</schedule_event>
</returns>
エラー番号
説明
GRN_UTIL_API_65009
アップロードするファイルのサイズが、Base64 エンコード後で300MBより大きい場合
GRN_SCHD_13011
開始と終了の日時のデータの組み合わせが正しくない場合 クラウド版およびパッケージ版 Garoon 6.0 以降で発生するエラー番号です。 パッケージ版 Garoon 6.0 より前では、PHP00099 エラーが発生します。
繰り返し予定を変更する
固定リンクがコピーされました
変更する繰り返し予定の情報をリクエストとして受け取り、繰り返し予定を変更し、変更された繰り返し予定の情報をレスポンスとして返す API です。 リクエストの内容で、繰り返し予定の情報が上書きされます。指定を省いた項目は、空になります。 繰り返し予定のコメントの追加には、ScheduleAddFollowsToRepeatEvent を使用します。この API では追加できません。
ScheduleModifyRepeatEvents
使用可能なGaroonのバージョン
固定リンクがコピーされました
クラウド版 Garoon
パッケージ版 Garoon 3.0 以降
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<parameters>
<operation type="all" >
<schedule_event id="1" event_type="repeat" version="dummy" public_type="public"
plan="予定メニュー" detail="標題" description="メモ" timezone="Asia/Tokyo" >
<members>
<member>
<user id="1" ></user>
</member>
</members>
<repeat_info>
<condition type="day" start_date="2010-07-01" end_date="2010-09-01"
start_time="09:00:00" end_time="10:00:00" ></condition>
</repeat_info>
</schedule_event>
</operation>
</parameters>
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<returns>
<result>
<original id="1"
event_type="repeat"
public_type="public"
plan="予定メニュー"
detail="標題"
description="メモ"
version="1281489472"
timezone="Asia/Tokyo"
allday="false"
start_only="false" >
<members xmlns="http://schemas.cybozu.co.jp/schedule/2008" >
<member>
<user id="1" name="Administrator" order="0" />
</member>
</members>
<repeat_info xmlns="http://schemas.cybozu.co.jp/schedule/2008" >
<condition type="day" day="0"
week="0" start_date="2010-07-01" end_date="2010-09-01"
start_time="09:00:00" end_time="10:00:00" />
<exclusive_datetimes>
<exclusive_datetime start="2010-06-17T00:00:00+09:00"
end="2010-06-18T00:00:00+09:00" />
</exclusive_datetimes>
</repeat_info>
</original>
<modified id="1"
event_type="repeat"
public_type="public"
plan="予定メニュー"
detail="標題"
description="メモ"
version="1281489472"
timezone="Asia/Tokyo"
allday="false"
start_only="false" >
<members xmlns="http://schemas.cybozu.co.jp/schedule/2008" >
<member>
<user id="1" name="Administrator" order="0" />
</member>
</members>
<repeat_info xmlns="http://schemas.cybozu.co.jp/schedule/2008" >
<condition type="day" day="0"
week="0" start_date="2010-07-01" end_date="2010-09-01"
start_time="09:00:00" end_time="10:00:00" />
<exclusive_datetimes>
<exclusive_datetime start="2010-06-17T00:00:00+09:00"
end="2010-06-18T00:00:00+09:00" />
</exclusive_datetimes>
</repeat_info>
</modified>
</result>
</returns>
登録した予定を削除する API です。 この API は、削除成功した場合空の SOAP メッセージを返します。入力した予定 ID の中に存在しない予定 ID が含まれる場合は、削除処理が行われず、エラーメッセージ(GRN_SCHD_13001)が返されます。
ScheduleRemoveEvents
使用可能なGaroonのバージョン
固定リンクがコピーされました
クラウド版 Garoon
パッケージ版 Garoon 3.0 以降
パラメーター名
型
パラメーター数
説明
event_id/text()
base:IDType
1 ~ 無制限
削除する予定のID
例
1
2
3
<parameters >
<event_id>72</event_id>
</parameters>
なし
この API は、削除成功した場合空の SOAP メッセージを返します。
入力した予定 ID の中に存在しない予定 ID が含まれる場合は、削除処理が行われず、エラーメッセージ(GRN_SCHD_13001)が返されます。
エラー番号
説明
GRN_SCHD_13001
存在しない予定 ID を event_id に指定した場合
繰り返し予定を削除する
固定リンクがコピーされました
予定 ID と削除範囲をリクエストとして受け取り、繰り返し予定を削除し、削除した繰り返し予定の情報をレスポンスとして返す API です。 この API は、削除成功した場合空の SOAP メッセージを返します。入力した予定 ID の中に存在しない予定 ID が含まれる場合は、削除処理が行われず、エラーメッセージ(GRN_SCHD_13001)が返されます。
ScheduleRemoveEventsFromRepeatEvent
使用可能なGaroonのバージョン
固定リンクがコピーされました
クラウド版 Garoon
パッケージ版 Garoon 3.0 以降
例
1
2
3
<parameters>
<operation event_id="1" type="after" date="2010-08-01" ></operation>
</parameters>
なし
エラー番号
説明
GRN_SCHD_13001
存在しない予定 ID を event_id に指定した場合