Garoon APIドキュメント

通知を取得する

目次

通知の更新情報を取得する

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

取得する通知のIDとversion、取得期間、取得するアプリケーションモジュールIDをリクエストのパラメーターとして受け取り、通知の更新情報を返すAPIです。
リクエストのversionとGaroonのもつversionが異なる場合、レスポンスでその通知のoperationは、"modify"となります。
リクエストの通知が存在する場合、レスポンスでその通知のoperationは、"add"となります。
存在しない通知をリクエストした場合、レスポンスでその通知のoperationは、"remove"となります。
これらの情報は更新情報です。このAPIによって更新が行われることはありません。

API名

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

NotificationGetNotificationVersions

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

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

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

リクエスト

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

クラウド版Garoon、パッケージ版Garoon 4.2以降
パラメーター名 型 パラメーター数 説明
notification_item notification:NotificationItemVersionType 0～ 無制限
  • 0：通知のバージョンが指定されていない
 更新情報を取得する通知のIDとバージョン
@start xsd:dateTime 1 通知の更新情報の取得開始日時
@end xsd:dateTime 0～1 通知の更新情報の取得終了日時
@module_id base:IDType 0～1
  • 0：すべてのアプリケーションの通知を受け取る
 取得する通知のアプリケーションID
  • スケジュール：grn.schedule
  • 施設の利用申請：grn.schedule.facility_approval
  • メッセージ：grn.message
  • 掲示板：grn.bulletin
  • ファイル管理：grn.cabinet
  • 電話メモ：grn.phonemessage
  • メール：grn.mail
  • ワークフロー：grn.workflow
  • マルチレポート：grn.report
  • スペース：grn.space
  • スペースのディスカッション：grn.space.discussion
  • スペースの共有ToDo：grn.space.todo
  • サイボウズからのお知らせ：Cybozu Information
  • 外部通知：外部通知の設定で登録した順にx.1、x.2、x.3、etc
パッケージ版Garoon 3.0～4.0
パラメーター名 型 パラメーター数 説明
notification_item notification:NotificationItemVersionType 0～ 無制限
  • 0：通知のバージョンが指定されていない
 更新情報を取得する通知のIDとバージョン
@start xsd:dateTime 1 通知の更新情報の取得開始日時
@end xsd:dateTime 0～1 通知の更新情報の取得終了日時
@module_id base:IDType 0～1
  • 0：すべてのアプリケーションの通知を受け取る
 取得する通知のアプリケーションID
  • スケジュール：grn.schedule
  • メッセージ：grn.message
  • 掲示板：grn.bulletin
  • ファイル管理：grn.cabinet
  • 電話メモ：grn.phonemessage
  • メール：grn.mail
  • ワークフロー：grn.workflow
  • マルチレポート：grn.report
  • スペース：grn.space
  • スペースのディスカッション：grn.space.discussion
  • スペースの共有ToDo：grn.space.todo
  • サイボウズからのお知らせ：Cybozu Information
  • 外部通知：外部通知の設定で登録した順にx.1、x.2、x.3、etc
例
1
2
3
4
5
6
7
8
9

<parameters start="2010-01-01T00:00:00Z" end="2010-01-02T00:00:00Z"
 module_id="grn.message">
  <notification_item version="11">
    <notification_id module_id="grn.message" item="1" />
  </notification_item>
  <notification_item version="66">
    <notification_id module_id="grn.message" item="2" />
  </notification_item>
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
notification_item notification:NotificationItemVersionResultType 0～ 無制限
  • 0：指定した条件に一致する通知の更新情報がない
 通知の更新情報
例
1
2
3
4
5
6
7
8

<returns>
  <notification_item id="1" version="1276056643" operation="modify">
    <notification_id module_id="grn.message" item="1" />
  </notification_item>
  <notification_item id="6" version="0" operation="remove">
    <notification_id module_id="grn.message" item="2" />
  </notification_item>
</returns>

通知を取得する

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

一意のIDとアプリケーションモジュールIDをリクエストのパラメーターとして受け取り、指定した通知の情報をレスポンスとして返すAPIです。
指定した通知が存在しない場合、APIは空の情報が返ります。

API名

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

NotificationGetNotificationsById

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
notification_id notification:NotificationIdType 1～ 無制限 取得する通知のアプリケーションIDと一意のID
例
1
2
3
4

<parameters>
  <notification_id module_id="grn.message" item="1" />
  <notification_id module_id="grn.mail" item="2" />
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
notification notification:NotificationType 0～ 無制限 取得した通知の情報
例
1
2
3
4
5
6
7
8
9

<returns>
  <notification module_id="grn.message" item="1" status="create" is_history="false"
    version="1276036644" receive_datetime="2010-01-01T00:00:00Z" subject="subject"
    sender_name="Administrator" sender_id="1" attached="false" />
  <notification module_id="grn.mail" item="2" status="create" is_history="false"
    version="1276042245" receive_datetime="2010-01-02T00:00:00Z" subject="subject"
    abstract="user1" sender_name="&quot;Administrator&quot;" sender_id="1"
    attached="false" />
</returns>

確認済み通知の更新情報を取得する

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

取得する通知のIDとversion、取得期間、取得するアプリケーションモジュールIDをリクエストのパラメーターとして受け取り、確認済み通知の更新情報を返すAPIです。
リクエストのversionとGaroonのもつversionが異なる場合、レスポンスでその確認済み通知のoperationは、"modify"となります。
リクエストしなかった確認済み通知が存在する場合、レスポンスでその確認済み通知のoperationは、"add"となります。
存在しない確認済み通知をリクエストした場合、レスポンスでその確認済み通知のoperationは、"remove"となります。

API名

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

NotificationGetNotificationHistoryVersions

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

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

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

リクエスト

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

クラウド版Garoon、パッケージ版Garoon 4.2以降
パラメーター名 型 パラメーター数 説明
notification_history_item notification:NotificationItemVersionType 0～ 無制限
  • 0：確認済み通知の通知のバージョンが指定されていない
 更新情報を取得する確認済み通知のIDとバージョン
@start xsd:dateTime 1 確認済み通知の更新情報の取得開始日時
@end xsd:dateTime 0～1 確認済み通知の更新情報の取得終了日時
@module_id base:IDType 0～1
  • 0：すべてのアプリケーションの通知を受け取る
 取得する通知のアプリケーションID
  • スケジュール：grn.schedule
  • 施設の利用申請：grn.schedule.facility_approval
  • メッセージ：grn.message
  • 掲示板：grn.bulletin
  • ファイル管理：grn.cabinet
  • 電話メモ：grn.phonemessage
  • メール：grn.mail
  • ワークフロー：grn.workflow
  • マルチレポート：grn.report
  • スペース：grn.space
  • スペースのディスカッション：grn.space.discussion
  • スペースの共有ToDo：grn.space.todo
  • サイボウズからのお知らせ：Cybozu Information
  • 外部通知：外部通知の設定で登録した順にx.1、x.2、x.3、etc
パッケージ版Garoon 3.0～4.0
パラメーター名 型 パラメーター数 説明
notification_history_item notification:NotificationItemVersionType 0～ 無制限
  • 0：確認済み通知の通知のバージョンが指定されていない
 更新情報を取得する確認済み通知のIDとバージョン
@start xsd:dateTime 1 確認済み通知の更新情報の取得開始日時
@end xsd:dateTime 0～1 確認済み通知の更新情報の取得終了日時
@module_id base:IDType 0～1
  • 0：すべてのアプリケーションの通知を受け取る
 取得する通知のアプリケーションID
  • スケジュール：grn.schedule
  • メッセージ：grn.message
  • 掲示板：grn.bulletin
  • ファイル管理：grn.cabinet
  • 電話メモ：grn.phonemessage
  • メール：grn.mail
  • ワークフロー：grn.workflow
  • マルチレポート：grn.report
  • スペース：grn.space
  • スペースのディスカッション：grn.space.discussion
  • スペースの共有ToDo：grn.space.todo
  • サイボウズからのお知らせ：Cybozu Information
  • 外部通知：外部通知の設定で登録した順にx.1、x.2、x.3、etc
例
1
2
3
4
5
6
7
8
9

<parameters start="2010-01-01T00:00:00Z" end="2010-01-02T00:00:00Z"
 module_id="grn.message">
  <notification_history_item version="11">
    <notification_id module_id="grn.message" item="1" />
  </notification_history_item>
  <notification_history_item version="66">
    <notification_id module_id="grn.message" item="2" />
  </notification_history_item>
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
notification_history_item notification:NotificationItemVersionResultType 0～ 無制限- 0：指定した条件に一致する確認済み通知の更新情報がない 確認済み通知の更新情報
例
1
2
3
4
5
6
7
8

<returns>
  <notification_history_item id="1" version="1276056643" operation="modify">
    <notification_id module_id="grn.message" item="1" />
  </notification_history_item>
  <notification_history_item id="6" version="0" operation="remove">
    <notification_id module_id="grn.message" item="2" />
  </notification_history_item>
</returns>

確認済み通知を取得する

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

一意のIDとアプリケーションモジュールIDをリクエストのパラメーターとして受け取り、指定した確認済み通知の情報をレスポンスとして返すAPIです。
notification_history_idで指定した通知が存在しない場合、APIは空の情報が返ります。

API名

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

NotificationGetNotificationHistoriesById

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
notification_history_id notification:NotificationIdType 1～ 無制限 取得する確認済み通知のアプリケーションIDと一意のID
例
1
2
3
4

<parameters>
  <notification_history_id module_id="grn.message" item="1" />
  <notification_history_id module_id="grn.mail" item="2" />
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
notification_history notification:NotificationType 0～ 無制限 取得した確認済み通知の情報
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

<returns>
  <notification_history module_id="grn.message" item="1" status="create" is_history="true"
   version="1276036644" read_datetime="2010-10-12T04:37:08Z"
   receive_datetime="2010-01-01T00:00:00Z" subject="subject"
   sender_name="Administrator" sender_id="1" attached="false" />
  <notification_history module_id="grn.mail" item="2" status="create" is_history="true"
   version="1276042245" read_datetime="2010-10-12T04:37:08Z"
   receive_datetime="2010-01-02T00:00:00Z" subject="subject"
   abstract="user1" sender_name="&quot;Administrator&quot;" sender_id="1"
   attached="false" />
</returns>