Garoon APIドキュメント

メッセージを取得する

目次

メッセージの更新情報を取得する

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

メッセージの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：終了日時を指定しない 取得期間の終了日時
例
1
2
3
4

<parameters start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z">
  <thread_item id="2" version="1"></thread_item>
  <folder_id>2</folder_id>
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
folder_item base:ItemVersionResultType 0～ 無制限- 0：指定したフォルダーの更新情報がない folder_itemで指定されたフォルダーの更新情報
例
1
2
3
4

<returns>
  <thread_item id="2" version="0" operation="remove" />
  <thread_item id="3" version="1278417620" operation="add" />
</returns>

メッセージを取得する

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

メッセージIDをリクエストのパラメーターとして受け取り、指定したメッセージの情報をレスポンスとして返すAPIです。APIを実行するユーザーが宛先／差出人に含まれているメッセージのみ取得されます。

API名

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

MessageGetThreadsById

使用できるバージョン

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
thread_id/text() xsd:string 1～ 無制限 メッセージ情報を取得するメッセージのID
例
1
2
3

<parameters>
  <thread_id>2</thread_id>
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
thread message:ThreadType 0～ 無制限 取得したメッセージの情報
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

<returns>
  <thread id="2" version="10000" confirm="false" subject="テスト" is_draft="false">
    <addressee user_id="1" name="佐藤" deleted="false" confirmed="false" />
    <content body="本文" html_body="<p>書式付本文</p>">
      <file id="1" name="ファイル.txt" size="1000" mime_type="text/plain" />
    </content>
    <follow id="2" number="2" />
    <follow id="1" number="1" />
    <creator user_id="1" name="佐藤" date="2009-02-02T00:00:00" />
    <modifier user_id="1" name="佐藤" date="2009-02-02T00:00:00" />
  </thread>
</returns>

エラー

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

エラー番号 説明
GRN_MSSG_15003 指定したメッセージIDが存在しない場合