予定を取得する

フォローする

Index

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

予定の更新情報を返すAPI です。予定のIDとversion、取得期間をリクエストのパラメーターとして受け取り、予定の更新情報をレスポンスとして返します。 API実行ユーザーが宛先に入っている予定のみレスポンスで返します。 リクエストで受け取ったversionとガルーンが保持しているversionが異なる場合、レスポンスにおいてその予定のoperationは、「modify」となります。 リクエストで受け取らなかった予定が存在する場合、レスポンスでその予定のoperationは、「add」となります。 API実行ユーザーが宛先に入っていない、あるいはガルーン上に存在しない予定をリクエストで受け取った場合、レスポンスでその予定の operation は、「remove」となります。

API名

ScheduleGetEventVersions

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

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.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 終日予定と期間予定の取得期間の終了日付

<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:予定の更新情報がない
予定の更新情報

<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 on cybozu
  • パッケージ版 バージョン 3.0.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の期間内の予定に加えて、指定した期間内の期間予定、および終日予定が取得されます。

<parameters start="2010-07-01T08:00:00" end="2010-07-03T20:00:00"> </parameters>

レスポンス

パラメーター名 パラメーター数 説明
schedule_event schedule:EventType 0 ~ 無期限 条件に一致する予定の一覧

<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 on cybozu、パッケージ版 バージョン 3.1.0以降
エラー番号 説明
GRN_SCHD_10401 endがstartよりも過去になっています。
GRN_SCHD_13227 ISO8601以外の形式の日付を指定した場合
GRN_SCHD_19015 startが指定されていません。

 

パッケージ版 バージョン 3.0.x
エラー番号 説明
GRN_SCHD_10401 endがstartよりも過去になっています。
GRN_SCHD_19015 startが指定されていません。

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

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

API名

ScheduleGetEventsById

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

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

パラメーター名 パラメーター数 説明
event_id/text() base:IDType 1 ~ 無期限 取得する予定のID

<parameters> 
  <event_id xmlns="">1</event_id> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
schedule_event schedule:EventType 0 ~ 無制限 event_idで指定された予定の情報

<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 on cybozu
  • パッケージ版 バージョン 3.0.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つのパラメーターの内、一つは必ず指定する必要があります。

<parameters start="2010-07-01T07:00:00" end="2010-07-03T20:00:00"> 
  <user id="5"></user> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
schedule_event schedule:EventType 0 ~ 無制限 条件に一致する予定の情報

<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>

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

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

Avatar
Kousuke Taniguchi

ScheduleGetEventsの@end_for_dailyの説明文にて、「指定した期間内の帰還予定」とありますが、ただしくは「指定した期間内の期間予定」ではないでしょうか?

Avatar
cybozu Development team

ご連絡が遅くなりまして申し訳ありません。ご指摘の通りで修正しました。

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