Trendsic Platform Service

<back to all web services

DispatchCommsRequest

Requires Authentication
The following routes are available for this service:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"MovingMph":0,"MovingHoldSecs":0,"RelayVoice":false}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}