Garoon APIドキュメント

空き予定を検索する

目次

空き予定を検索する

固定リンクがコピーされました

ユーザー／組織／施設の空き時間を検索します。

  • 最大で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」を指定すると、次の時間帯で空き予定を取得できます。
  • 8時〜9時
  • 9時〜10時
attendees 配列 条件必須 参加者の一覧
attendeesまたはfacilitiesが必須です。
attendees[].type 文字列 条件必須 参加者のタイプ
次のいずれかの値を指定します。
  • ORGANIZATION：組織
  • USER：ユーザー
attendeesを指定する場合は必須です。
attendees[].id 文字列 条件必須 組織またはユーザー情報のID
attendees[].typeに指定する値ごとに異なります。
  • 「ORGANIZATION」 の場合：組織ID
  • 「USER」 の場合：GaroonユーザーID
attendeesを指定する場合、attendees[].idまたはattendees[].codeが必須です。
attendees[].code 文字列 条件必須 組織またはユーザー情報のコード
attendees[].typeに指定する値ごとに異なります。
  • 「ORGANIZATION」 の場合：組織コード
  • 「USER」 の場合：Garoonユーザー名（ログイン名）
    パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。
    詳細は ユーザー情報の項目を変更する (External link) を参照してください。
attendees[].idまたはattendees[].codeが必須です。
どちらも指定すると、attendees[].idの値が設定されます。
facilities 配列 条件必須 施設の一覧
attendeesまたはfacilitiesが必須です。
施設を更新するときは、すべての施設を指定してください。
空配列を指定すると、施設がすべて削除されます。
facilities[].id 文字列 条件必須 施設ID
facilitiesを指定する場合、facilities[].idまたはfacilities[].codeが必須です。
facilities[].code 文字列 条件必須 施設コード
facilitiesを指定する場合、facilities[].idまたはfacilities[].codeが必須です。
両方を指定すると、facilities[].idの値が設定されます。
facilitySearchCondition 文字列 省略可 施設検索の条件
次のいずれかの値を指定します。
  • AND
  • OR
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は Garoon REST APIの共通仕様 を参照してください。

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

{
  "timeRanges": [
    {
      "start": "2018-01-01T09:00:00+09:00",
      "end": "2018-01-02T09:00:00+09:00"
    }
  ],
  "timeInterval": "60",
  "attendees": [
    {
      "id": "1",
      "type": "USER",
      "code": "c000001"
    }
  ],
  "facilities": [
    {
      "id": "5",
      "code": "roa"
    }
  ],
  "facilitySearchCondition": "OR"
}

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
availableTimes 配列 空き予定の候補
availableTimes[].start.dateTime 文字列 空き予定の開始日時
availableTimes[].start.timeZone 文字列 空き予定の開始日時のタイムゾーン
availableTimes[].end.dateTime 文字列 空き予定の終了日時
availableTimes[].end.timeZone 文字列 空き予定の終了日時のタイムゾーン
availableTimes[].facility.id 数値 組織ID
availableTimes[].facility.code 文字列 組織コード
availableTimes[].facility.name 文字列 組織名
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

{
  "availableTimes": [
    {
      "start": {
        "dateTime": "2018-08-08T00:00:00+09:00",
        "timeZone": "Asia/Tokyo"
      },
      "end": {
        "dateTime": "2018-08-08T01:00:00+09:00",
        "timeZone": "Asia/Tokyo"
      },
      "facility": {
        "id": "1",
        "code": "F001",
        "name": "28F conference room"
      }
    }
  ]
}

サンプルコード

固定リンクがコピーされました

curlを使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

curl -X POST 'https://sample.cybozu.com/g/api/v1/schedule/searchAvailableTimes' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "timeRanges": [
      {
        "start": "2020-06-09T09:00:00+09:00",
        "end": "2020-06-09T10:00:00+09:00"
      }
    ],
    "timeInterval": "60",
    "facilities": [
      {
        "code": "SeminarA"
      }
    ]
  }'
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

const body = {
  timeRanges: [
    {
      start: '2020-06-09T09:00:00+09:00',
      end: '2020-06-09T10:00:00+09:00'
    }
  ],
  timeInterval: 60,
  facilities: [
    {
      code: 'SeminarA'
    }
  ]
};

await garoon.api('/api/v1/schedule/searchAvailableTimes', 'POST', body);