Trendsic Platform Service

<back to all web services

UserNotificationsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/UserNotifications/{AgentId}
DELETE,OPTIONS/v1/UserNotifications/{NotificationId}
UserNotificationsRequest Parameters:
NameParameterData TypeRequiredDescription
AgentIdpathintNo
NotificationIdpathintNo
ShowDeletedqueryboolNo
UserNotificationsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NotificationsformList<UserNotification>No
DeletedformboolNo
UserNotification Parameters:
NameParameterData TypeRequiredDescription
NotificationIdformintNo
AgentIdformintNo
DescriptionformstringNo
FromformstringNo
CreatedDateformDateTimeNo
TypeformstringNo
URLformstringNo
RefIdformstringNo
IsDeletedformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/UserNotifications/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Notifications: 
	[
		{
			NotificationId: 0,
			AgentId: 0,
			Description: String,
			From: String,
			CreatedDate: 0001-01-01,
			Type: String,
			URL: String,
			RefId: String,
			IsDeleted: False
		}
	],
	Deleted: False
}