予定を登録、更新、または削除する

フォローする

Index

予定を登録する

予定を登録するAPIです。 リクエストで送信するEventType型パラメーターにはid、versionといった更新時に必要なパラメーターもありますが、本APIは新規作成のため、それぞれ「dummy」や「-1」など無効なことを表す値を指定してください。

API名

ScheduleAddEvents

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

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

リクエスト

パラメーター名 パラメーター数 説明
schedule_event schedule:EventType 1 ~ 無制限 登録する予定の情報

<parameters> 
  <schedule_event  
    xmlns=""  
    id="dummy"  
    event_type="normal"  
    version="dummy"  
    public_type="public"  
    plan="打合" 
    detail="新製品について"  
    description="新製品についての打合せです"  
    timezone="Asia/Tokyo" 
    end_timezone="Asia/Tokyo" 
    allday="true"  
    start_only="false"> 
    <members> 
      <member> 
        <user id="1"></user> 
      </member> 
      <member> 
        <user id="2"></user> 
      </member> 
    </members> 
    <when> 
      <datetime start="2010-07-04T09:00:00" end="2010-07-04T10:00:00"></datetime> 
    </when> 
  </schedule_event> 
</parameters>

レスポンス

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

<returns> 
  <schedule_event  
    id="46988" 
    event_type="normal"  
    public_type="public"  
    plan="打合” 
    detail="新製品について” 
    description="新製品についての打合せです"  
    version="1278033362" 
    timezone="Asia/Tokyo" 
    end_timezone=”Asia/Tokyo” 
    allday="false"  
    start_only="false" > 
    <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <member> 
        <user id="1" name="佐藤 太郎" order="0"/> 
      </member> 
      <member> 
        <user id="2" name="萩澤 淳平" order="1"/> 
      </member> 
    </members> 
    <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <datetime start="2010-07-04T09:00:00Z" end="2010-07-04T10:00:00Z"/> 
    </when> 
  </schedule_event> 
</returns>

予定を変更する

登録した予定を修正するAPIです。この API は、入力した予定 ID を元に予定を特定して変更します。 リクエストで送信した内容で、予定の情報が上書きされます。指定を省いた項目は、空になります。 予定のコメントの追加には、ScheduleAddFollowsを使用します。この API では追加できません

API名

ScheduleModifyEvents

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

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

リクエスト

パラメーター名 パラメーター数 説明
schedule_event schedule:EventType 1 ~ 無制限 変更する予定の情報

<parameters > 
  <schedule_event xmlns="" id="72"  
    event_type="normal" version="123"  
    public_type="public" timezone="Asia/Tokyo" 
    allday="false" start_only="false"> 
    <members> 
      <member> 
        <user id="6" order="1"></user> 
      </member> 
    </members> 
    <when> 
      <datetime start="2010-07-09T02:00:00Z" end="2010-07-09T04:00:00Z"> 
      </datetime> 
    </when> 
  </schedule_event> 
</parameters>

レスポンス

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

<returns> 
  <schedule_event id="72" 
    event_type="normal"  
    public_type="public"  
    version="1278567340" 
    timezone="Asia/Tokyo" 
    allday="false"  
    start_only="false"> 
    <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <member> 
        <user id="6" name="佐藤 昇" order="0"/> 
      </member> 
    </members> 
    <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <datetime start="2010-07-09T02:00:00Z" end="2010-07-09T04:00:00Z"/> 
    </when> 
  </schedule_event> 
</returns>

繰り返し予定を変更する

変更する繰り返し予定の情報をリクエストとして受け取り、繰り返し予定を変更し、変更された繰り返し予 定の情報をレスポンスとして返す API です。 リクエストで送信した内容で、繰り返し予定の情報が上書きされます。指定を省いた項目は、空になります。 繰り返し予定のコメントの追加には、ScheduleAddFollowsToRepeatEventを使用します。このAPIでは追加できません。

API名

ScheduleModifyRepeatEvents

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

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

リクエスト

パラメーター名 パラメーター数 説明
operation schedule:ScheduleModifyRepeatEventsOperationType 1 ~ 無制限 変更する繰り返し予定の情報


<parameters> 
  <operation type="all"> 
    <schedule_event id="1" event_type="repeat" version="dummy" public_type="public"  
     plan="予定メニュー" detail="標題" description="メモ" timezone="Asia/Tokyo"> 
      <members> 
        <member> 
          <user id="1"></user> 
        </member> 
      </members> 
      <repeat_info> 
        <condition type="day" start_date="2010-07-01" end_date="2010-09-01"  
         start_time="09:00:00" end_time="10:00:00"></condition> 
      </repeat_info> 
    </schedule_event> 
  </operation> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
result

schedule:ScheduleModifyRepeatEventsResultType

0 ~ 無制限

変更された繰り返し予定の情報

  <returns> 
    <result> 
    <original id="1" 
     event_type="repeat"  
     public_type="public"  
     plan="予定メニュー"  
     detail="標題"  
     description="メモ"  
     version="1281489472" 
     timezone="Asia/Tokyo" 
     allday="false"  
     start_only="false" > 
      <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <member> 
          <user id="1" name="Administrator" order="0"/> 
        </member> 
      </members> 
      <repeat_info xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <condition type="day" day="0"   
         week="0" start_date="2010-07-01" end_date="2010-09-01" 
         start_time="09:00:00" end_time="10:00:00"/> 
        <exclusive_datetimes> 
          <exclusive_datetime start="2010-06-17T00:00:00+09:00"  
           end="2010-06-18T00:00:00+09:00" /> 
      </exclusive_datetimes> 
      </repeat_info> 
    </original> 
    <modified id="1" 
     event_type="repeat"  
     public_type="public"  
     plan="予定メニュー"  
     detail="標題"  
     description="メモ"  
     version="1281489472" 
     timezone="Asia/Tokyo" 
     allday="false"  
     start_only="false" > 
      <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <member> 
          <user id="1" name="Administrator" order="0"/> 
        </member> 
      </members> 
      <repeat_info xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <condition type="day" day="0"   
         week="0" start_date="2010-07-01" end_date="2010-09-01" 
         start_time="09:00:00" end_time="10:00:00"/> 
        <exclusive_datetimes> 
          <exclusive_datetime start="2010-06-17T00:00:00+09:00"  
           end="2010-06-18T00:00:00+09:00" /> 
        </exclusive_datetimes> 
      </repeat_info> 
    </modified> 
  </result> 
</returns>

予定を削除する

登録した予定を削除するAPIです。 このAPIは、削除成功した場合空のSOAPメッセージを返します。入力した予定IDの中に存在しない予定 ID が含まれる場合は、削除処理が行われず、エラーメッセージ(GRN_SCHD_13001)が返されます。

API名

ScheduleRemoveEvents

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

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

リクエスト

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

<parameters > 
  <event_id>72</event_id> 
</parameters>

レスポンス

なし

解説

  • このAPIは、削除成功した場合空のSOAPメッセージを返します。
  • 入力した予定IDの中に存在しない予定 ID が含まれる場合は、削除処理が行われず、エラーメッセージ(GRN_SCHD_13001)が返されます。

エラー

エラー番号 説明
GRN_SCHD_13001 存在しない予定IDをevent_idに指定した場合

繰り返し予定を削除する

予定IDと削除範囲をリクエストとして受け取り、繰り返し予定を削除し、削除した繰り返し予定の情報をレ スポンスとして返す API です。 この API は、削除成功した場合空の SOAP メッセージを返します。入力した予定 ID の中に存在しない予定 ID が含まれる場合は、削除処理が行われず、エラーメッセージ(GRN_SCHD_13001)が返されます。

API名

ScheduleRemoveEventsFromRepeatEvent

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

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

リクエスト

パラメーター名 パラメータ数 説明
operation schedule:ScheduleRemoveEventsFromRepeatEventOperationType 1 ~ 無制限 削除する繰り返し予定のIDと削除範囲

 

<parameters> 
  <operation event_id="1" type="after" date="2010-08-01"></operation> 
</parameters>

レスポンス

なし

エラー

エラー番号 説明
GRN_SCHD_13001 存在しない予定IDをevent_idに指定した場合

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

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

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