施設の更新情報を取得する
施設の更新情報を取得する API です。更新情報を取得する施設の ID とバージョンをリクエストとして取得し、施設の更新情報をレスポンスとして返します。
API名
ScheduleGetFacilityVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
facility_item | base:ItemVersionType | 0 ~ 無制限 | 更新情報を取得する施設のIDとバージョン |
例
<parameters> <facility_item id="1" version="1281588600"></facility_item> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
facility_item | base:ItemVersionResultType | 0 ~ 無制限 | 施設の更新情報 |
例
<returns> <facility_item id="1" version="1281588693" operation="modify" /> <facility_item id="2" version="1281588705" operation="add" /> <facility_item id="3" version="1281588716" operation="add" /> </returns>
施設情報を取得する
施設情報を取得するAPIです。 施設の ID をリクエストとして受け取り、施設の情報をレスポンスとして返す APIです。
API名
ScheduleGetFacilitiesById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
facility_id | base:IDType | 0 ~ 無制限 | 情報を取得する施設ID |
例
<parameters> <facility_id>1</facility_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
facility_item | schedule:FacilityType | 0 ~ 無制限 | 施設の情報 |
例
<returns> <facility key="1" name="会議室 1" order="2147483647" version="1281588693" facility_code="faccode1"/> </returns>
施設グループの更新情報を取得する
施設グループの更新情報を取得する API です。 施設グループの ID とバージョンをリクエストとして受けとり、施設グループの更新情報をレスポンスとして返す API です。
API名
ScheduleGetFacilityGroupsVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
facility_group_item | base:ItemVersionType | 0 ~ 無制限 | 更新情報を取得する施設グループのIDとバージョン |
例
<parameters> <facility_group_item id="1" version="1281588693"></facility_group_item> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
facility_group_item | base:ItemVersionResultType | 0 ~ 無制限 | 施設グループの更新情報 |
例
<returns> <facility_group_item id="1" version="1281589500" operation="modify" /> <facility_group_item id="2" version="1281589518" operation="add" /> </returns>
施設グループ情報を取得する
施設グループ情報を取得するAPIです。 施設グループ ID をリクエストとして受け取り、施設グループの詳細な情報をレスポンスとして返す API です。
API名
ScheduleGetFacilityGroupsById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
facility_group_id | base:IDType | 1 ~ 無制限 | 情報を取得する施設グループID |
例
<parameters> <facility_group_id>1</facility_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
facility_group | - | 0 ~ 無制限 | 施設グループの情報 |
facility_group/@id | base:IDType | 1 | 施設グループID |
facility_group/@name | base:NonBlankStringType | 1 | 施設名 |
facility_group/@version | base:VersionType | 1 | バージョン |
facility_group/@order | xsd:unsignedLong | 0 ~ 1 | 表示順序 |
facility_group/@parent_facility_group | base:IDType | 0 ~ 1 | 親施設グループID |
facility_group/facility_group | 0 ~ 無制限 | 子施設グループ | |
facility_group/facility_group/@id | base:IDType | 1 | 子施設グループID |
facility_group/facility | 0 ~ 無制限 | 子施設 | |
facility_group/facility/@id | base:IDType | 1 | 子施設ID |
例
<returns> <facility_group id="1" name="施設グループ 1" version="1281589500" order="2147483647" xmlns="http://schemas.cybozu.co.jp/schedule/2008"> <facility_group id="3" /> </facility_group> </returns>
施設の設定の更新情報を取得する
施設の設定の更新情報を返すAPIです。
施設のIDとversionをリクエストのパラメータとして受け取り、施設の設定の更新情報をレスポンスとして返します。リクエストで受け取ったversionとガルーンが保持しているversionが異なる場合、レスポンスにおいてその施設の設定のoperationは、「modify」となります。
リクエストで受け取らなかった施設の設定が存在する場合、レスポンスでその施設の設定のoperationは、「add」となります。 ガルーン上に存在しない施設をリクエストで受け取った場合、レスポンスでその施設の設定の operation は、「remove」となります。
API名
ScheduleGetFacilityProfileVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 4.2.0以降
リクエスト
パラメーター名 | 型 | パラメータ数 | 説明 |
facility_profile_item | base:ItemVersionType | 0 ~ 無制限 | 更新情報を取得する施設のIDとバージョン |
例
<parameters> <facility_profile_item id="1" version="1281588600"></facility_profile_item> </parameters>
レスポンス
パラメーター名 | 型 | パラメータ数 | 説明 |
facility_profile_item | base:ItemVersionResultType | 0 ~ 無制限 | 施設の設定の更新情報 |
例
<returns> <facility_profile_item id="1" version="1281588693" operation="modify" /> <facility_profile_item id="2" version="1281588705" operation="add" /> <facility_profile_item id="3" version="1281588716" operation="add" /> </returns>
施設の設定情報を取得する
施設の設定情報を取得するAPIです。
施設の ID をリクエストとして受け取り、施設の設定情報をレスポンスとして返します。
API名
ScheduleGetFacilityProfilesById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 4.2.0以降
リクエスト
パラメーター名 | 型 | パラメータ数 | 説明 |
facility_id | base:IDType | 無制限 | 設定を取得する施設ID |
例
<parameters> <facility_id>1</facility_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメータ数 | 説明 |
facility_profile | schedule:FacilityProfileType | 0 ~ 無制限 | 情報を取得する施設ID |
例
<returns> <facility_profile key="1" approval_required="true" /> </returns>
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。