フォルダの更新情報を取得する
フォルダの ID と version をリクエストのパラメーターとして受け取り、フォルダの更新情報を返す API で す。 リクエストで受け取った version とガルーンが持つ version が異なる場合、レスポンスでそのフォルダのoperation は、”modify”となります。 リクエストで受け取らなかったフォルダが存在する場合、レスポンスでそのフォルダの operationは、”add”となります。 存在しないフォルダをリクエストで受け取った場合、レスポンスでそのフォルダの operation は、”remove”となります。これらの情報は更新情報であり、本APIによって更新が行われることはありません。
API名
MessageGetFolderVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
folder_item | base:ItemVersionType | 0 ~ 無制限
|
更新情報を取得するフォルダのIDとバージョン |
例
<parameters> <folder_item id="1" version="11" /> <folder_item id="6" version="66" /> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
folder_item | base:ItemVersionResultType | 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名
MessageGetFoldersById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 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>
パッケージ版Garoon 3.7.5を使用しておりますが、MessageGetFolderById ではなく、MessageGetFolder"s"ById ではないでしょうか。
WSDL ファイルにもそのように定義されておりました。
Yuji 様
お世話になっております。cybozu developer network でございます。
ご指摘ありがとうございます。
ご指摘頂いた通り、MessageGetFoldersById が正しいです。
ご迷惑をおかけし申し訳ありません。
ドキュメントの方修正させていただきました。
よろしくお願いいたします。