フォルダを取得する

フォローする

フォルダの更新情報を取得する

フォルダの ID と version をリクエストのパラメーターとして受け取り、フォルダの更新情報を返す API で す。 リクエストで受け取った version とガルーンが持つ version が異なる場合、レスポンスでそのフォルダのoperation は、”modify”となります。 リクエストで受け取らなかったフォルダが存在する場合、レスポンスでそのフォルダの operationは、”add”となります。 存在しないフォルダをリクエストで受け取った場合、レスポンスでそのフォルダの operation は、”remove”となります。これらの情報は更新情報であり、本APIによって更新が行われることはありません。

API名

MessageGetFolderVersions

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

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

リクエスト

パラメーター名 パラメーター数 説明
folder_item base:ItemVersionType 0 ~ 無制限
  • 0:フォルダのバージョンが指定されていない
更新情報を取得するフォルダのIDとバージョン

<parameters> 
  <folder_item id="1" version="11" />  
  <folder_item id="6" version="66" />  
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
folder_item base:ItemVersionResultType 0 ~ 無制限
  • 0:指定したフォルダの更新情報が無い
更新情報を取得したフォルダの更新情報

<returns> 
  <folder_item id="1" version="1276056643" operation="modify" /> 
  <folder_item id="6" version="0" operation="remove" /> 
  <folder_item id="2" version="1276056643" operation="add" /> 
  <folder_item id="3" version="1276056643" operation="add" /> 
  <folder_item id="4" version="1276056643" operation="add" /> 
  <folder_item id="5" version="1276056643" operation="add" /> 
</returns>

フォルダを取得する

フォルダ ID をリクエストのパラメーターとして受け取り、指定したフォルダの情報をレスポンスとして返すAPI です。

API名

MessageGetFolderById

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

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

リクエスト

パラメーター名 パラメーター数 説明
folder_id/text() xsd:string 1 ~ 無制限 フォルダの情報を取得するフォルダのID

<parameters> 
  <folder_id>2</folder_id> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
folder message:MessageFolderType 0 ~ 無制限 取得したフォルダの情報

<returns> 
  <folder id="2" version="1276056643" name="受信箱" order="1" parent_folder_id="1" folder_type="received"> 
    <thread id="3" /> 
    <thread id="4" /> 
    <thread id="5" /> 
  </folder> 
</returns>

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

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

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