空き予定を検索する
ユーザー/組織/施設の空き時間を検索します。
- 最大で10件の空き時間を取得できます。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/schedule/searchAvailableTimes
パッケージ版
環境に合わせてそれぞれ以下を置き換えてください。
IP_ADDRESS_OR_HOST_NAME
:Garoonのインストール先のIPアドレスまたはホスト名INSTALL_IDENTIFER
:Garoonのインストール識別子
- Windows環境
- https://
IP_ADDRESS_OR_HOST_NAME
/scripts/INSTALL_IDENTIFER
/grn.exe/api/v1/schedule/searchAvailableTimes - Linux環境
- https://
IP_ADDRESS_OR_HOST_NAME
/cgi-bin/INSTALL_IDENTIFER
/grn.cgi/api/v1/schedule/searchAvailableTimes
HTTPメソッド
POST
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 5.0以降
必要なアクセス権
- 予定の追加権限
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
timeRanges | 配列 | 必須 | 時間範囲 |
timeRanges[].start | 文字列 | 必須 | 時間の検索範囲(開始時間) |
timeRanges[].end | 文字列 | 必須 | 時間の検索範囲(終了時間) |
timeInterval | 数値 | 必須 | 空き予定の時間の間隔 1から1,439まで指定できます。 たとえば、 timeRanges[].start を8時、timeRanges[].end を10時に設定した場合、timeInterval に「60」を指定すると、次の時間帯で空き予定を取得できます。
|
attendees | 配列 | 条件必須 | 参加者の一覧attendees またはfacilities が必須です。 |
attendees[].type | 文字列 | 条件必須 | 参加者のタイプ 次のいずれかの値を指定します。
attendees を指定する場合は必須です。 |
attendees[].id | 文字列 | 条件必須 | 組織またはユーザー情報のIDattendees[].type に指定する値ごとに異なります。
attendees を指定する場合、attendees[].id またはattendees[].code が必須です。 |
attendees[].code | 文字列 | 条件必須 | 組織またはユーザー情報のコードattendees[].type に指定する値ごとに異なります。
attendees[].id またはattendees[].code が必須です。どちらも指定すると、 attendees[].id の値が設定されます。 |
facilities | 配列 | 条件必須 | 施設の一覧attendees またはfacilities が必須です。施設を更新するときは、すべての施設を指定してください。 空配列を指定すると、施設がすべて削除されます。 |
facilities[].id | 文字列 | 条件必須 | 施設IDfacilities を指定する場合、facilities[].id またはfacilities[].code が必須です。 |
facilities[].code | 文字列 | 条件必須 | 施設コードfacilities を指定する場合、facilities[].id またはfacilities[].code が必須です。両方を指定すると、 facilities[].id の値が設定されます。 |
facilitySearchCondition | 文字列 | 省略可 | 施設検索の条件 次のいずれかの値を指定します。
|
リクエストの例
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
availableTimes | 配列 | 空き予定の候補 |
availableTimes[].start.dateTime | 文字列 | 空き予定の開始日時 |
availableTimes[].start.timeZone | 文字列 | 空き予定の開始日時のタイムゾーン |
availableTimes[].end.dateTime | 文字列 | 空き予定の終了日時 |
availableTimes[].end.timeZone | 文字列 | 空き予定の終了日時のタイムゾーン |
availableTimes[].facility.id | 数値 | 組織ID |
availableTimes[].facility.code | 文字列 | 組織コード |
availableTimes[].facility.name | 文字列 | 組織名 |
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
|
|
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
|
|