Trendsic Platform Service

<back to all web services

BroadcastRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Broadcast/{BroadcastId}
GET,OPTIONS/v1/Broadcast
"use strict";
export class Broadcast {
    /** @param {{BroadcastId?:number,BroadcastTitle?:string,BroadcastDescription?:string,BroadcastBegin?:string,BroadcastBeginTime?:string,BroadcastEnd?:string,BroadcastEndTime?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    BroadcastId;
    /** @type {string} */
    BroadcastTitle;
    /** @type {string} */
    BroadcastDescription;
    /** @type {string} */
    BroadcastBegin;
    /** @type {string} */
    BroadcastBeginTime;
    /** @type {string} */
    BroadcastEnd;
    /** @type {string} */
    BroadcastEndTime;
}
export class BroadcastResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Broadcast?:Broadcast[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Broadcast[]} */
    Broadcast = [];
}
export class BroadcastRequest {
    /** @param {{Broadcast?:Broadcast[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Broadcast[]} */
    Broadcast = [];
}

JavaScript BroadcastRequest 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/Broadcast/{BroadcastId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Broadcast: 
	[
		{
			BroadcastId: 0,
			BroadcastTitle: String,
			BroadcastDescription: String,
			BroadcastBegin: 0001-01-01,
			BroadcastBeginTime: String,
			BroadcastEnd: 0001-01-01,
			BroadcastEndTime: String
		}
	]
}