| GET,PUT | /v1/dispatch/comms |
|---|
"use strict";
export class WorkerCommsView {
/** @param {{MovingMph?:number,MovingHoldSecs?:number,RelayVoice?:boolean,RelayReady?:boolean,HasOwnNumber?:boolean,RelayNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
MovingMph;
/** @type {number} */
MovingHoldSecs;
/** @type {boolean} */
RelayVoice;
/** @type {boolean} */
RelayReady;
/** @type {boolean} */
HasOwnNumber;
/** @type {string} */
RelayNumber;
}
export class WorkerCommsResponse {
/** @param {{Comms?:WorkerCommsView,Number?:string,Code?:string,Message?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {WorkerCommsView} */
Comms;
/** @type {string} */
Number;
/** @type {string} */
Code;
/** @type {string} */
Message;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class DispatchCommsRequest {
/** @param {{MovingMph?:number,MovingHoldSecs?:number,RelayVoice?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
MovingMph;
/** @type {number} */
MovingHoldSecs;
/** @type {boolean} */
RelayVoice;
}
JavaScript DispatchCommsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/dispatch/comms HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
MovingMph: 0,
MovingHoldSecs: 0,
RelayVoice: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Comms:
{
MovingMph: 0,
MovingHoldSecs: 0,
RelayVoice: False,
RelayReady: False,
HasOwnNumber: False,
RelayNumber: String
},
Number: String,
Code: String,
Message: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}