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}
"use strict";
export class UserNotification {
    /** @param {{NotificationId?:number,AgentId?:number,Description?:string,From?:string,CreatedDate?:string,Type?:string,URL?:string,RefId?:string,IsDeleted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    NotificationId;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    Description;
    /** @type {string} */
    From;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    Type;
    /** @type {string} */
    URL;
    /** @type {string} */
    RefId;
    /** @type {boolean} */
    IsDeleted;
}
export class UserNotificationsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Notifications?:UserNotification[],Deleted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {UserNotification[]} */
    Notifications = [];
    /** @type {boolean} */
    Deleted;
}
export class UserNotificationsRequest {
    /** @param {{AgentId?:number,NotificationId?:number,ShowDeleted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {number} */
    NotificationId;
    /** @type {boolean} */
    ShowDeleted;
}

JavaScript UserNotificationsRequest 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/UserNotifications/{AgentId} 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":[{"NotificationId":0,"AgentId":0,"Description":"String","From":"String","CreatedDate":"0001-01-01T00:00:00.0000000","Type":"String","URL":"String","RefId":"String","IsDeleted":false}],"Deleted":false}