予定を取得する

目次

予定の更新情報を取得する

予定の更新情報を返す API です。 API を実行するユーザーが参加している、かつ指定した期間内に存在する予定のみ、予定のバージョンを返します。

API名

ScheduleGetEventVersions

使用可能なGaroonのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名 パラメーター数 説明
event_item base:ItemVersionType 0 ~ 無制限
0:予定のバージョンを指定しない
更新情報を取得する予定のIDとバージョン
@start xsd:dateTime 1 取得期間の開始日時
@end xsd:dateTime 0 ~ 1 取得期間の終了日時
@start_for_daily xsd:date 0 ~ 1 終日予定と期間予定の取得期間の開始日付
@end_for_daily xsd:date 0 ~ 1 終日予定と期間予定の取得期間の終了日付
1
2
3
4
<parameters start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z" start_for_daily="2010-07-01" end_for_daily="2010-09-01"> 
  <event_item id="1" version="1378260785"></event_item> 
  <event_item id="2" version="1378260884"></event_item>
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
event_item base:ItemVersionResultType 0 ~ 無制限
  • 0:予定の更新情報がない
予定の更新情報
operation の値は、次のようになります。
  • add
    • リクエストに指定していない予定
  • remove
    • リクエストに指定したが、存在しない予定
    • リクエストに指定したが、API を実行するユーザーが参加していない予定
    • リクエストに指定したが、取得期間外である予定
      繰り返し予定をリクエストに指定した場合は、繰り返し予定のすべての予定が取得期間外のとき
  • modify
    • リクエストに指定した version と異なる予定
      繰り返し予定をリクエストに指定した場合は、繰り返し予定の少なくとも 1 つの予定が取得期間内のとき
1
2
3
4
5
<returns> 
  <event_item id="1" version="1378260789" operation="modify" /> 
  <event_item id="2" version="0" operation="remove" /> 
  <event_item id="3" version="1378260986" operation="add" /> 
</returns>

指定した期間の予定を取得する

リクエスト内のパラメーターに指定された日時の範囲内の予定を取得する API です。 API を実行するユーザーが参加している予定のみ取得されます。

API名

ScheduleGetEvents

使用可能なGaroonのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名 パラメーター数 説明
@start xsd:dateTime 1 検索期間の開始日時
@end xsd:dateTime 1 検索期間の終了日時
@start_for_daily xsd:date 0 ~ 1 終日予定と期間予定を検索する期間の開始日
@end_for_daily xsd:date 0 ~ 1 終日予定と期間予定を検索する期間の終了日
@start_for_daily と @end_for_daily を指定すると、@start と @end の期間内の予定に加えて、指定した期間内の期間予定、および終日予定が取得されます。
1
<parameters start="2010-07-01T08:00:00" end="2010-07-03T20:00:00"> </parameters>

レスポンス

パラメーター名 パラメーター数 説明
schedule_event schedule:EventType 0 ~ 無期限 条件に一致する予定の一覧
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
<returns> 
  <schedule_event id="46984" 
     event_type="normal"  
     public_type="public"  
     plan="メニュー1"  
     detail="予定タイトル"  
     description="予定メモ"
     version="1277974578" 
     timezone="Asia/Tokyo" 
     end_timezone="Asia/Tokyo"
     allday="true"  
     start_only="false" > 
    <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <member> 
        <user id="1" name="佐藤 太郎" order="0"/> 
      </member> 
    </members> 
    <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <date start="2010-07-01" end="2010-07-01" /> 
    </when> 
  </schedule_event> 
</returns>

エラー

クラウド版 Garoon、パッケージ版 Garoon 3.1 以降
エラー番号 説明
GRN_SCHD_10401 end が start よりも過去になっています。
GRN_SCHD_13227 ISO8601 以外の形式の日付を指定した場合
GRN_SCHD_19015 start が指定されていません。
パッケージ版 Garoon 3.0
エラー番号 説明
GRN_SCHD_10401 end が start よりも過去になっています。
GRN_SCHD_19015 start が指定されていません。

指定したIDの予定を取得する

リクエスト内で指定された予定 ID に対応する予定の詳細情報を取得する API です。 API を実行するユーザーに取得対象の予定に対する閲覧権限があれば取得可能です。 指定した予定 ID に対応する予定が存在しない場合、API は空の情報を返します。

API名

ScheduleGetEventsById

使用可能なGaroonのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名 パラメーター数 説明
event_id/text() base:IDType 1 ~ 無制限 取得する予定のID
1
2
3
<parameters> 
  <event_id xmlns="">1</event_id> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
schedule_event schedule:EventType 0 ~ 無制限 event_id で指定された予定の情報
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
<returns> 
  <schedule_event id="1" 
   event_type="normal"  
   public_type="public"  
   plan="メニュー1"  
   detail="予定タイトル"  
   description="予定メモ"  
   version="1277974578" 
   timezone="Asia/Tokyo" 
   end_timezone="Asia/Tokyo" 
   allday="true"  
   start_only="false" > 
    <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <member> 
        <user id="1" name="佐藤 太郎" order="0"/> 
      </member> 
    </members> 
    <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <date start="2010-07-01" end="2010-07-01" /> 
    </when> 
  </schedule_event> 
</returns>

エラー

エラー番号 説明
GRN_SCHD_13001 指定した予定へのアクセス権を持っていない場合

指定したユーザー、組織、または施設の予定を取得する

指定した期間内にあるユーザー、組織、施設のいずれかの予定を取得する API です。

API名

ScheduleGetEventsByTarget

使用可能なGaroonのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名 パラメーター数 説明
@start xsd:dateTime 1 検索期間の開始日時
@end xsd:dateTime 1 検索期間の終了日時
@start_for_daily xsd:date 0 ~ 1 終日予定と期間予定を検索する期間の開始日
@end_for_daily xsd:date 0 ~ 1 終日予定と期間予定を検索する期間の終了日
user/@id base:IDType 0 ~ 1 予定を検索するユーザーを指定する
group/@id base:IDType 0 ~ 1 予定を検索する組織を指定する
facility/@id base:IDType 0 ~ 1 予定を検索する施設を指定する
  • user、group、facility パラメーターは同時に指定できません。
  • 上記 3 つのパラメーターの内、ひとつは必ず指定する必要があります。
1
2
3
<parameters start="2010-07-01T07:00:00" end="2010-07-03T20:00:00"> 
  <user id="5"></user> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
schedule_event schedule:EventType 0 ~ 無制限 条件に一致する予定の情報
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
<returns> 
    <schedule_event id="1" 
       event_type="normal"  
       public_type="public"  
       plan="メニュー1"  
       detail="予定タイトル"  
       description="予定メモ"  
       version="1277974578" 
       timezone="Asia/Tokyo" 
       end_timezone="Asia/Tokyo" 
       allday="true"  
       start_only="false" > 
      <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <member> 
          <user id="5" name="川崎 茂" order="0"/> 
        </member> 
      </members> 
      <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <date start="2010-07-01" end="2010-07-01" /> 
      </when> 
    </schedule_event> 
</returns>