予定を検索する
検索文字列と検索期間を指定して、API実行ユーザーが参加している予定を探す API です。 次の項目について、それぞれ検索対象にするかどうかを指定できます。
- タイトル(title_search)
- 顧客先(customer_search)
- メモ(memo_search)
- コメント(follow_search)
検索期間は日時や日付で指定します。両方を指定すると、日付の指定が優先されます。 検索期間条件に一つの繰り返し予定が一致する場合、all_repeat_events のオプションで返す結果に最初の日程を入れるか、あるいは全ての日程を入れるかを選択できます。
API名
ScheduleSearchEvents
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 |
パラメーター数 |
説明 |
@text | xsd:string | 1 | 検索文字列 |
@start | xsd:dateTime | 0 ~ 1 | 検索開始日時 |
@end | xsd:dateTime | 0 ~ 1 | 検索終了日時 |
@start_for_daily | xsd:date | 0 ~ 1 | 検索開始日付 |
@end_for_daily | xsd:date | 0 ~ 1 | 検索終了日付 |
@title_search | xsd:boolean | 1 | タイトル検索オプション |
@customer_search | xsd:boolean | 1 | 顧客先検索オプション |
@memo_search | xsd:boolean | 1 | メモ検索オプション |
@follow_search | xsd:boolean | 1 | コメント検索オプション |
@all_repeat_events | xsd:boolean | 1 | 繰り返し予定の全てを表示
|
例
<parameters text="Test" start="2010-07-06T02:00:00Z" end="2010-07-07T02:00:00Z" title_search="true" customer_search="false" memo_search="false" follow_search="false" all_repeat_events="false"> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
schedule_event | schedule:EventType | 0 ~ 無制限 | 検索条件に一致する予定 |
例
<returns> <schedule_event id="66" event_type="normal" public_type="public" detail="Test schedule" version="1278497751" timezone="Asia/Tokyo" end_timezone=”Asia/Tokyo” allday="false" start_only="false"> <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> <member> <user id="7" name="鈴木 拓也" order="0"/> </member> <member> <facility id="4" name="第一会議室" order="1"/> </member> </members> <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> <datetime start="2010-07-07T01:00:00Z" end="2010-07-07T02:00:00Z"/> </when> </schedule_event> </returns>
予定の空き時間を検索する
検索条件を基に空き時間を検索する API です。
API名
ScheduleSearchFreeTimes
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
candidate | schedule:ScheduleSearchFreeTimesCandidateType | 1 ~ 無制限 | 時間候補 |
member | schedule:MemberType | 1 ~ 無制限 | 参加者 |
@search_time | xsd:time | 1 | 所要時間 |
@search_condition | schedule:ScheduleSearchConditionType | 1 | 施設の条件 |
例
<parameters search_time="00:30:00" search_condition="and"> <candidate start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z"> </candidate> <member> <user id="1"></user> </member> <member> <user id="2"></user> </member> <member> <user id="3"></user> </member> </parameters>
レスポンス
パラメーター数 | 型 | パラメーター数 | 説明 |
candidate | schedule:ScheduleFreeTimeType | 0 ~ 無制限 | 日時候補(最大10) |
例
<returns> <candidate start="2010-06-30T16:00:00Z" end="2010-06-30T16:30:00Z" /> <candidate start="2010-06-30T16:30:00Z" end="2010-06-30T17:00:00Z" /> <candidate start="2010-06-30T17:00:00Z" end="2010-06-30T17:30:00Z" /> <candidate start="2010-06-30T17:30:00Z" end="2010-06-30T18:00:00Z" /> <candidate start="2010-06-30T18:00:00Z" end="2010-06-30T18:30:00Z" /> <candidate start="2010-06-30T18:30:00Z" end="2010-06-30T19:00:00Z" /> <candidate start="2010-06-30T19:00:00Z" end="2010-06-30T19:30:00Z" /> <candidate start="2010-06-30T19:30:00Z" end="2010-06-30T20:00:00Z" /> <candidate start="2010-06-30T20:00:00Z" end="2010-06-30T20:30:00Z" /> <candidate start="2010-06-30T20:30:00Z" end="2010-06-30T21:00:00Z" /> </returns>
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。