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
"use strict";
export class NotificationHeader {
    /** @param {{NotificationHeaderId?:number,Subject?:string,Status?:string,NeedsCloseApproval?:boolean,IsDeleted?:boolean,CreatedBy?:number,DateCreated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    NotificationHeaderId;
    /** @type {string} */
    Subject;
    /** @type {string} */
    Status;
    /** @type {boolean} */
    NeedsCloseApproval;
    /** @type {boolean} */
    IsDeleted;
    /** @type {number} */
    CreatedBy;
    /** @type {string} */
    DateCreated;
}
export class Notification extends NotificationHeader {
    /** @param {{NotificationHeaderId?:number,Subject?:string,Status?:string,NeedsCloseApproval?:boolean,IsDeleted?:boolean,CreatedBy?:number,DateCreated?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class NotificationsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Notifications?:Notification[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Notification[]} */
    Notifications = [];
}
export class NotificationsRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript NotificationsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000"}]}