Index
予定に参加する
API実行ユーザーが予定に参加するAPIです。この API は、参加したい予定の ID をリクエストとして受けとり、API実行ユーザーが該当予定に参加する処理を実行し、参加した後の予定の情報をレスポンスとして返します。 繰り返し予定と仮予定には参加できません。繰り返し予定に参加する場合は、ScheduleParticipateEventsToRepeatEventを使用します。
API名
ScheduleParticipateEvents
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| event_id/text() | base:IDType | 1 ～ 無制限 | 参加する予定のID |
例
<parameters > <event_id>70</event_id> </parameters>
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
| schedule_event | schedule:EventType | 0 ～ 無制限 | 参加した予定の詳細 |
例
<returns>
<schedule_event id="70"
event_type="normal" public_type="public"
plan="出張" detail="大阪"
version="1278568183" timezone="JST"
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-07T22:00:00Z" end="2010-07-08T14:00:00Z"/>
</when>
<follows xmlns="http://schemas.cybozu.co.jp/schedule/2008">
<follow id="1" text="Suzuki write a comment"
version="1278565662">
<creator user_id="7" name="鈴木 拓也"
date="2010-07-08T05:07:42Z" />
</follow>
</follows>
</schedule_event>
</returns>
予定から抜ける
API実行ユーザーを参加中の予定から外すAPIです。この API は、抜けたい予定の ID をリクエストとして受けとり、API実行ユーザーが該当予定から抜ける処理が行われ、抜けた後の予定の情報をレスポンスとして返します。繰り返し予定と仮予定からは抜けることができません。繰り返し予定から抜ける場合はScheduleLeaveEventsFromRepeatEventを使用します。
API名
ScheduleLeaveEvents
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| event_id/text() | base:IDType | 1 ～ 無制限 | 抜けたい予定のID |
例
<parameters > <event_id>72</event_id> </parameters>
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
| schedule_event | schedule:EventType | 0 ～ 無制限 | 抜けた後の予定の詳細 |
例
<returns>
<schedule_event id="72"
event_type="normal"
public_type="public"
detail="Normal schedule (Sato + Suzuki)"
version="1278566550"
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-09T03:00:00Z"/>
</when>
</schedule_event>
</returns>
繰り返し予定に参加する
API実行ユーザーが繰り返し予定に参加するAPIです。 この API は、参加したい繰り返し予定の 情報 をリクエストとして受けとり、API実行ユーザーが該当の繰り返し予定に参加する処理を実行し、参加した後の繰り返し予定の情報をレスポンスとして返します。 ガルーンを画面から操作した場合と同様に、次の操作を行うと、参加した予定は繰り返し予定から通常予定に変わります。
- 特定の日の予定のみに参加する
- 特定の日以降の予定のみに参加する
API名
ScheduleParticipateEventsToRepeatEvent
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| operation | schedule:ScheduleParticipateEventsToRepeatEventOperationType | 1 ～ 無制限 | 参加する繰り返し予定の情報 |
例
<parameters> <operation event_id="3" type="all"></operation> </parameters>
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
| result | schedule:ScheduleModifyRepeatEventsResultType | 0 ～ 無制限 | 参加した予定の情報 |
例
<returns>
<result>
<original id="3" event_type="repeat" public_type="public"
detail="repeat event" version="1281585504" timezone="Asia/Tokyo"
allday="true" start_only="false">
<members xmlns="http://schemas.cybozu.co.jp/schedule/2008">
<member><user id="2" name="user1" order="0"/></member>
<member><user id="3" name="user2" order="1"/></member>
<member><user id="4" name="user3" order="2"/></member>
<member><user id="1" name="Administrator" order="3"/></member>
</members>
<repeat_info xmlns="http://schemas.cybozu.co.jp/schedule/2008">
<condition type="day" day="13" week="5" start_date="2010-08-13"
end_date="2010-08-18" />
<exclusive_datetimes></exclusive_datetimes>
</repeat_info>
</original>
<modified id="3" event_type="repeat"
public_type="public" detail="repeat event"
version="1281585504" timezone="Asia/Tokyo"
allday="true" start_only="false">
<members xmlns="http://schemas.cybozu.co.jp/schedule/2008">
<member><user id="2" name="user1" order="0"/></member>
<member><user id="3" name="user2" order="1"/></member>
<member><user id="4" name="user3" order="2"/></member>
<member><user id="1" name="Administrator" order="3"/></member>
</members>
<repeat_info xmlns="http://schemas.cybozu.co.jp/schedule/2008">
<condition type="day" day="13" week="5" start_date="2010-08-13"
end_date="2010-08-18" />
<exclusive_datetimes></exclusive_datetimes>
</repeat_info>
</modified>
</result>
</returns>
繰り返し予定から抜ける
API実行ユーザーを参加中の繰り返し予定から外す API です。 この API は、抜けたい繰り返し予定の情報をリクエストとして受けとり、API実行ユーザーが該当の繰り返し予定から抜ける処理が行われ、抜けた後の繰り返し予定の情報をレスポンスとして返します。 ガルーンを画面から操作した場合と同様に、次の操作を行うと、参加した予定は繰り返し予定から通常予定に変わります。
- 特定の日の予定のみに参加する
- 特定の日以降の予定のみに参加する
API名
ScheduleLeaveEventsFromRepeatEvent
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| operation | schedule:ScheduleRemoveEventsFromRepeatEventOperationType | 1 ～ 無制限 | 抜ける繰り返し予定の情報 |
例
<parameters> <operation xmlns="" event_id="3" type="all"></operation> </parameters>
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
| result | schedule:ScheduleModifyRepeatEventsResultType | 0 ～ 無制限 | 抜けた繰り返し予定の情報 |
例
<returns>
<result>
<original id="3" event_type="repeat" public_type="public" detail="repeat event"
version="1281586852" timezone="Asia/Tokyo" allday="true" start_only="false" >
<members xmlns="http://schemas.cybozu.co.jp/schedule/2008">
<member><user id="2" name="user1" order="0"/></member>
<member><user id="3" name="user2" order="1"/></member>
<member><user id="4" name="user3" order="2"/></member>
</members>
<repeat_info xmlns="http://schemas.cybozu.co.jp/schedule/2008">
<condition type="day" day="13" week="5" start_date="2010-08-13"
end_date="2010-08-18" />
<exclusive_datetimes></exclusive_datetimes>
</repeat_info>
</original>
<modified id="3" event_type="repeat" public_type="public" detail="repeat event"
version="1281586852" timezone="Asia/Tokyo" allday="true" start_only="false" >
<members xmlns="http://schemas.cybozu.co.jp/schedule/2008">
<member><user id="2" name="user1" order="0"/></member>
<member><user id="3" name="user2" order="1"/></member>
<member><user id="4" name="user3" order="2"/></member>
</members>
<repeat_info xmlns="http://schemas.cybozu.co.jp/schedule/2008">
<condition type="day" day="13" week="5" start_date="2010-08-13"
end_date="2010-08-18" />
<exclusive_datetimes></exclusive_datetimes>
</repeat_info>
</modified>
</result>
</returns>
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。