Trendsic Platform Service

<back to all web services

DispatchNoticeRequest

The following routes are available for this service:
GET,OPTIONS/v1/dispatch/notice/{Token}/json
"use strict";
export class DispatchNoticeResponse {
    /** @param {{RefCode?:string,RecipientName?:string,Headline?:string,Body?:string,AffectedText?:string,OriginalWindow?:string,NewWindow?:string,ScopeLabel?:string,Reason?:string,HoldStatus?:string,ResumesUtc?:string,Acked?:boolean,Invalid?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RefCode;
    /** @type {string} */
    RecipientName;
    /** @type {string} */
    Headline;
    /** @type {string} */
    Body;
    /** @type {string} */
    AffectedText;
    /** @type {string} */
    OriginalWindow;
    /** @type {string} */
    NewWindow;
    /** @type {string} */
    ScopeLabel;
    /** @type {string} */
    Reason;
    /** @type {string} */
    HoldStatus;
    /** @type {?string} */
    ResumesUtc;
    /** @type {boolean} */
    Acked;
    /** @type {boolean} */
    Invalid;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchNoticeRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

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

GET /v1/dispatch/notice/{Token}/json HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	RefCode: String,
	RecipientName: String,
	Headline: String,
	Body: String,
	AffectedText: String,
	OriginalWindow: String,
	NewWindow: String,
	ScopeLabel: String,
	Reason: String,
	HoldStatus: String,
	ResumesUtc: 0001-01-01,
	Acked: False,
	Invalid: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}