メッセージを取得する
メッセージの更新情報を取得する
メッセージのIDとversion、フォルダーID、取得期間をリクエストのパラメーターとして受け取り、メッセージの更新情報を返すAPIです。
リクエストで受け取ったversionとGaroon上のversionが異なる場合、レスポンスでそのメッセージのoperationは、"modify"となります。
リクエストで受け取らなかったメッセージが存在する場合、レスポンスでそのメッセージのoperationは、"add"となります。
APIを実行するユーザーが宛先/差出人に含まれていない場合や、存在しないメッセージをリクエストで受け取った場合、レスポンスにおけるそのメッセージのoperationは、"remove"となります。
これらの情報は更新情報です。このAPIによって更新が行われることはありません。
API名
MessageGetThreadVersions
使用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| thread_item | base:ItemVersionType | 0~ 無制限- 0:メッセージのバージョンが指定されていない | 更新情報を取得するメッセージのIDとバージョン |
| folder_id/text() | base:IDType | 0~ 無制限- 0:すべてのフォルダーから取得する | 更新情報を取得するフォルダーのID |
| @start | xsd:dateTime | 1 | 取得期間の開始日時 |
| @end | xsd:dateTime | 0~1- 0:終了日時を指定しない | 取得期間の終了日時 |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| folder_item | base:ItemVersionResultType | 0~ 無制限- 0:指定したフォルダーの更新情報がない | folder_itemで指定されたフォルダーの更新情報 |
例
|
|
メッセージを取得する
メッセージIDをリクエストのパラメーターとして受け取り、指定したメッセージの情報をレスポンスとして返すAPIです。APIを実行するユーザーが宛先/差出人に含まれているメッセージのみ取得されます。
API名
MessageGetThreadsById
使用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| thread_id/text() | xsd:string | 1~ 無制限 | メッセージ情報を取得するメッセージのID |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| thread | message:ThreadType | 0~ 無制限 | 取得したメッセージの情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_MSSG_15003 | 指定したメッセージIDが存在しない場合 |
