Trendsic Platform Service

<back to all web services

OutgoingNotifications

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/OutgoingNotifications/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/OutgoingNotifications
"use strict";
export class OutgoingNotificationObject {
    /** @param {{Id?:string,CustomerId?:string,Message?:string,NotificationMethod?:string,DateSent?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    CustomerId;
    /** @type {string} */
    Message;
    /** @type {string} */
    NotificationMethod;
    /** @type {string} */
    DateSent;
}
export class OutgoingNotificationsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,OutgoingNotifications?:OutgoingNotificationObject[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {OutgoingNotificationObject[]} */
    OutgoingNotifications = [];
}
export class OutgoingNotifications extends OutgoingNotificationObject {
    /** @param {{ApiKey?:string,Id?:string,CustomerId?:string,Message?:string,NotificationMethod?:string,DateSent?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    ApiKey;
}

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

POST /v1/OutgoingNotifications/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	CustomerId: 00000000000000000000000000000000,
	Message: String,
	NotificationMethod: 00000000000000000000000000000000,
	DateSent: 0001-01-01
}
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
		}
	},
	OutgoingNotifications: 
	[
		{
			Id: 00000000000000000000000000000000,
			CustomerId: 00000000000000000000000000000000,
			Message: String,
			NotificationMethod: 00000000000000000000000000000000,
			DateSent: 0001-01-01
		}
	]
}