Trendsic Platform Service

<back to all web services

CustomerNotificationsSaveRequest

The following routes are available for this service:
PUT/v1/c/notifications
"use strict";
export class NotificationPrefView {
    /** @param {{Key?:string,Label?:string,Sub?:string,IsOn?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Label;
    /** @type {string} */
    Sub;
    /** @type {boolean} */
    IsOn;
}
export class CustomerNotificationsResponse {
    /** @param {{Audience?:string,Items?:NotificationPrefView[],Devices?:number,PushConfigured?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Audience;
    /** @type {NotificationPrefView[]} */
    Items = [];
    /** @type {number} */
    Devices;
    /** @type {boolean} */
    PushConfigured;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class NotificationPrefInput {
    /** @param {{Key?:string,IsOn?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {boolean} */
    IsOn;
}
export class CustomerNotificationsSaveRequest {
    /** @param {{Audience?:string,Items?:NotificationPrefInput[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Audience;
    /** @type {NotificationPrefInput[]} */
    Items = [];
}

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

PUT /v1/c/notifications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Audience: String,
	Items: 
	[
		{
			Key: String,
			IsOn: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Audience: String,
	Items: 
	[
		{
			Key: String,
			Label: String,
			Sub: String,
			IsOn: False
		}
	],
	Devices: 0,
	PushConfigured: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}