Garoon API ドキュメント

仮予定を確定または削除する

目次

仮予定を確定する

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

仮予定を確定する API です。この API は、確定させる仮予定の情報をリクエストとして受け取り、仮予定の確定処理を行い、確定した予定をレスポンスとして返します。 リクエストで送信する確定日時は UTC で指定する必要があります。

API名

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

ScheduleDetermineTemporaryEvents

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
candidate schedule:ScheduleCandidateItemType 1 ～ 無制限 確定する仮予定の情報
例
1
2
3
4

<parameters> 
  <candidate event_id="1" start="2010-08-13T00:00:00Z" end="2010-08-13T01:00:00Z">
  </candidate> 
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
schedule_event schedule:EventType 0 ～ 無制限 確定された予定の情報
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

<returns> 
  <schedule_event id="1" event_type="normal"  
   public_type="public" detail="仮予定"  
   version="1281580195" timezone="Asia/Tokyo" 
   end_timezone="Asia/Tokyo" 
   allday="false" start_only="false"> 
    <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <member><user id="5" name="user4" order="0"/></member> 
      <member><user id="4" name="user3" order="1"/></member> 
      <member><user id="3" name="user2" order="2"/></member> 
      <member><user id="2" name="user1" order="3"/></member> 
    </members> 
    <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <datetime start="2010-08-13T00:00:00Z" end="2010-08-13T01:00:00Z"/> 
    </when> 
  </schedule_event> 
</returns>

仮予定の候補を削除する

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

仮予定の候補を削除する API です。 この API は、削除する仮予定の情報をリクエストとして受け取り、仮予定の削除処理を実行し、削除した仮予定をレスポンスとして返します。 リクエストで送信する確定日時は UTC で指定する必要があります。

API名

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

ScheduleRemoveTemporaryEventCandidates

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
candidate schedule:ScheduleCandidateItemType 1 ～ 無制限 削除する仮予定の情報
例
1
2
3
4

<parameters> 
  <candidate event_id="2" start="2010-08-14T00:00:00" end="2010-08-14T01:00:00"> 
  </candidate> 
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
schedule_event schedule:EventType 0 ～ 無制限 削除した予定の情報
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

<returns> 
  <schedule_event id="2" event_type="temporary"  
   public_type="public" detail="仮予定"  
   version="1281580726" timezone="Asia/Tokyo" 
   end_timezone="Asia/Tokyo" 
   allday="false" start_only="false"> 
    <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <member><user id="5" name="user4" order="0"/></member> 
      <member><user id="4" name="user3" order="1"/></member> 
      <member><user id="3" name="user2" order="2"/></member> 
      <member><user id="2" name="user1" order="3"/></member> 
    </members> 
    <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
     <datetime start="2010-08-13T23:00:00Z" end="2010-08-14T00:00:00Z"/> 
     <datetime start="2010-08-14T01:00:00Z" end="2010-08-14T02:00:00Z"/> 
    </when> 
  </schedule_event> 
</returns>