Trendsic Platform Service

<back to all web services

IncomingNotifications

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/IncomingNotifications/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/IncomingNotifications
"use strict";
export class IncomingNotificationObject {
    /** @param {{Id?:string,CustomerId?:string,Message?:string,NotificationMethod?:string,DateReceived?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    CustomerId;
    /** @type {string} */
    Message;
    /** @type {string} */
    NotificationMethod;
    /** @type {string} */
    DateReceived;
}
export class IncomingNotificationsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,IncomingNotifications?:IncomingNotificationObject[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {IncomingNotificationObject[]} */
    IncomingNotifications = [];
}
export class IncomingNotifications extends IncomingNotificationObject {
    /** @param {{ApiKey?:string,Id?:string,CustomerId?:string,Message?:string,NotificationMethod?:string,DateReceived?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    ApiKey;
}

JavaScript IncomingNotifications 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.

POST /v1/IncomingNotifications/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"00000000000000000000000000000000","Id":"00000000000000000000000000000000","CustomerId":"00000000000000000000000000000000","Message":"String","NotificationMethod":"00000000000000000000000000000000","DateReceived":"0001-01-01T00:00:00.0000000"}

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"}},"IncomingNotifications":[{"Id":"00000000000000000000000000000000","CustomerId":"00000000000000000000000000000000","Message":"String","NotificationMethod":"00000000000000000000000000000000","DateReceived":"0001-01-01T00:00:00.0000000"}]}