通知の更新情報を取得する
取得する通知の ID と version、取得期間、取得するアプリケーションモジュール ID をリクエストのパラメーターとして受け取り、通知の更新情報を返す API です。 リクエストで受け取った version とガルーンが持つ version が異なる場合、レスポンスでその通知のoperation は、”modify”となります。 リクエストで受け取らなかった通知が存在する場合、レスポンスでその通知の operation は、”add”となります。 存在しない通知をリクエストで受け取った場合、レスポンスでその通知の operation は、”remove”となります。これらの情報は更新情報であり、本APIによって更新が行われることはありません。
API名
NotificationGetNotificationVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
notification_item | notification:NotificationItemVersionType | 0 ~ 無制限
|
更新情報を取得する通知のIDとバージョン |
@start | xsd:dateTime | 1 | 通知の更新情報の取得開始日時 |
@end | xsd:dateTime | 0 ~ 1 | 通知の更新情報の取得終了日時 |
@module_id | base:IDType | 0 ~ 1
|
取得する通知のアプリケーションID
|
パラメーター名 | 型 | パラメーター数 | 説明 |
notification_item | notification:NotificationItemVersionType | 0 ~ 無制限
|
更新情報を取得する通知のIDとバージョン |
@start | xsd:dateTime | 1 | 通知の更新情報の取得開始日時 |
@end | xsd:dateTime | 0 ~ 1 | 通知の更新情報の取得終了日時 |
@module_id | base:IDType | 0 ~ 1
|
取得する通知のアプリケーションID
|
例
<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 ~ 無制限
|
通知の更新情報 |
例
<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 バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
notification_id | notification:NotificationIdType | 1 ~ 無制限 | 取得する通知のアプリケーションIDと一意のID |
例
<parameters> <notification_id module_id="grn.message" item="1" /> <notification_id module_id="grn.mail" item="2" /> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
notification | notification:NotificationType | 0 ~ 無制限 | 取得した通知の情報 |
例
<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=""Administrator"" sender_id="1" attached="false" /> </returns>
確認済み通知の更新情報を取得する
取得する通知の ID と version、取得期間、取得するアプリケーションモジュール ID をリクエストのパラメーターとして受け取り、確認済み通知の更新情報を返す API です。 リクエストで受け取った version とガルーンが持つ version が異なる場合、レスポンスでその確認済み通知の operation は、”modify”となります。 リクエストで受け取らなかった確認済み通知が存在する場合、レスポンスでその確認済み通知のoperation は、”add”となります。 存在しない確認済み通知をリクエストで受け取った場合、レスポンスでその確認済み通知の operationは、”remove”となります。
API名
NotificationGetNotificationHistoryVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
notification_history_item | notification:NotificationItemVersionType | 0 ~ 無制限
|
更新情報を取得する確認済み通知のIDとバージョン |
@start | xsd:dateTime | 1 | 確認済み通知の更新情報の取得開始日時 |
@end | xsd:dateTime | 0 ~ 1 | 確認済み通知の更新情報の取得終了日時 |
@module_id | base:IDType | 0 ~ 1
|
取得する確認済み通知のアプリケーションID
|
パラメーター名 | 型 | パラメーター数 | 説明 |
notification_history_item | notification:NotificationItemVersionType | 0 ~ 無制限
|
更新情報を取得する確認済み通知のIDとバージョン |
@start | xsd:dateTime | 1 | 確認済み通知の更新情報の取得開始日時 |
@end | xsd:dateTime | 0 ~ 1 | 確認済み通知の更新情報の取得終了日時 |
@module_id | base:IDType | 0 ~ 1
|
取得する確認済み通知のアプリケーションID
|
例
<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 ~ 無制限
|
確認済み通知の更新情報 |
例
<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 バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
notification_history_id | notification:NotificationIdType | 1 ~ 無制限 | 取得する確認済み通知のアプリケーションIDと一意のID |
例
<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 ~ 無制限 | 取得した確認済み通知の情報 |
例
<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=""Administrator"" sender_id="1" attached="false" /> </returns>
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。