カテゴリー内の他の記事

空き予定の検索(POST)

フォローする

Index

空き予定の検索

ユーザー・組織・施設の利用可能時間を検索できます。

HTTP メソッド

POST

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/schedule/searchAvailableTimes

パッケージ版(Windows環境)

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/schedule/searchAvailableTimes

パッケージ版(Linux環境)

http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/schedule/searchAvailableTimes

使用可能なガルーンのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon バージョン 5.0.0以降

必要なアクセス権

予定の追加権限

リクエストの例

POST /g/api/v1/schedule/searchAvailableTimes HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
  • Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。

リクエストボディ

パラメータ 指定する値 必須 説明
timeRanges 配列 必須 時間範囲
timeRanges[].start 文字列 必須 時間範囲の開始時間
timeRanges[].end 文字列 必須 時間範囲の終了時間
timeInterval 数値 必須 時間間隔
最小:1
最大:1,439
attendees 配列 条件必須

参加者のリスト

※ attendees(参加者)または facilities(施設)のいずれかが必須です。

attendees[].type 文字列 条件必須

参加者のタイプ

次のいずれかの値を指定します。

  • ORGANIZATION
  • USER

※ attendees を指定する場合、必須です。

attendees[].id 文字列 条件必須

attendees[].type に指定した値により異なります。

  • 「ORGANIZATION」 の場合:組織ID
  • 「USER」 の場合:Garoon ユーザーID

※ attendees を指定する場合、id または code が必須です。

attendees[].code 文字列 条件必須 attendees[].type に指定した値により異なります。
  • 「ORGANIZATION」 の場合:組織コード
  • 「USER」 の場合:Garoon ユーザー名(ログイン名)

※ attendees を指定する場合、id または code が必須です。
※ id と code を指定すると、id の値が優先されます。

facilities 配列 条件必須

施設のリスト

※ attendees(参加者)または facilities(施設)のいずれかが必須です。

facilities[].id 数値 条件必須 

施設ID

※ facilities を指定する場合、id または code が必須です。

facilities[].code 文字列 条件必須 

施設コード

※ facilities を指定する場合、id または code が必須です。
※ id と code を指定すると、id の値が優先されます。

facilitySearchCondition 文字列 省略可 

施設検索の条件
次の2つの値から1つを指定できます。

  • AND
  • OR

レスポンスの例

処理が成功すると、予定の内容がJSON形式で返されます。

プロパティ

プロパティ名 説明
availableTimes[].start.dateTime 文字列

空き予定の開始日時

availableTimes[].start.timeZone 文字列 

空き予定の開始日時のタイムゾーン

availableTimes[].end.dateTime 文字列 

空き予定の終了日時

availableTimes[].end.timeZone 文字列 

空き予定の終了日時のタイムゾーン

facility.id 数値 

組織ID

facility.code 文字列 

組織コード

facility.name 文字列 

組織名

制限事項

共通仕様の制限事項 をご確認ください。

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。