Trendsic Platform Service

<back to all web services

NotificationsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Notifications

export class NotificationHeader
{
    public NotificationHeaderId: number;
    public Subject: string;
    public Status: string;
    public NeedsCloseApproval: boolean;
    public IsDeleted: boolean;
    public CreatedBy: number;
    public DateCreated: string;

    public constructor(init?: Partial<NotificationHeader>) { (Object as any).assign(this, init); }
}

export class Notification extends NotificationHeader
{

    public constructor(init?: Partial<Notification>) { super(init); (Object as any).assign(this, init); }
}

export class NotificationsResponse
{
    public ResponseStatus: ResponseStatus;
    public Notifications: Notification[] = [];

    public constructor(init?: Partial<NotificationsResponse>) { (Object as any).assign(this, init); }
}

export class NotificationsRequest
{

    public constructor(init?: Partial<NotificationsRequest>) { (Object as any).assign(this, init); }
}

TypeScript NotificationsRequest DTOs

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/Notifications 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: 
	[
		{
			NotificationHeaderId: 0,
			Subject: String,
			Status: String,
			NeedsCloseApproval: False,
			IsDeleted: False,
			CreatedBy: 0,
			DateCreated: 0001-01-01
		}
	]
}