List Notifications
GET/organizations/:organizationId/notifications
List notifications
Request
Path Parameters
organizationId stringrequired
The ID of organization.
Query Parameters
assetId string
The Id of asset.
startDate string
The start date number of query.
endDate string
The end date number of query.
maxResults number
Possible values: >= 10
and <= 100
The maximum number of results to return.
nextToken string
To retrieve the next set of results.
Responses
- 200
- 401
- 403
- 404
- 422
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- Array [
- ]
- ]
data object[]required
An array of notifications data.
id stringrequired
assetId stringrequired
source stringrequired
sourceId stringrequired
title stringrequired
description stringrequired
address stringrequired
chatRoomId stringrequired
entities object[]required
image stringrequired
{
"data": [
{
"id": "string",
"assetId": "string",
"source": "string",
"sourceId": "string",
"title": "string",
"description": "string",
"address": "string",
"chatRoomId": "string",
"entities": [
{}
],
"image": "string"
}
]
}
{
"data": [
{
"id": "ABCDE",
"assetId": "a-assetId",
"source": "Asset",
"sourceId": "ABCDE",
"title": "IDT-Asset-Title",
"description": "IDT-Asset-Description",
"address": "Taipei City",
"chatRoomId": "ABCDE",
"entities": [],
"image": "abc.png"
}
]
}
The request has not permission.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The request has not permission.
message stringrequired
The request has not permission message.
{
"error": "string",
"message": "string"
}
{
"error": "Unauthenticated",
"message": "Authentication is required and has failed or has not yet been provided."
}
The request has not permission.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The request has not permission.
message stringrequired
The request has not permission message.
{
"error": "string",
"message": "string"
}
{
"error": "Forbidden",
"message": "Access to the requested resource is forbidden."
}
The resource hasn't found.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The resource hasn't found.
message stringrequired
The resource hasn't found message.
{
"error": "string",
"message": "string"
}
{
"error": "ResourceNotFound",
"message": "The requested resource could not be found."
}
The input data has invalid.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The input data has invalid.
message stringrequired
The input data has invalid message.
{
"error": "string",
"message": "string"
}
{
"error": "ValidationError",
"message": "Input data validation failed."
}
Loading...