Garoon APIドキュメント

フォルダを取得する

目次

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

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

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

API名

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

MessageGetFolderVersions

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

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

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

リクエスト

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

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

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

レスポンス

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

パラメーター名 型 パラメーター数 説明
folder_item base:ItemVersionResultType 0～ 無制限
  • 0：指定したフォルダーの更新情報がない
 更新情報を取得したフォルダーの更新情報
例
1
2
3
4
5
6
7
8

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

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

MessageGetFoldersById

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

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

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

リクエスト

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

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

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

レスポンス

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

パラメーター名 型 パラメーター数 説明
folder message:MessageFolderType 0～ 無制限 取得したフォルダーの情報
例
1
2
3
4
5
6
7

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