Trendsic Platform Service

<back to all web services

DispatchCommsRequest

Requires Authentication
The following routes are available for this service:
GET,PUT/v1/dispatch/comms

export class WorkerCommsView
{
    public MovingMph: number;
    public MovingHoldSecs: number;
    public RelayVoice: boolean;
    public RelayReady: boolean;
    public HasOwnNumber: boolean;
    public RelayNumber: string;

    public constructor(init?: Partial<WorkerCommsView>) { (Object as any).assign(this, init); }
}

export class WorkerCommsResponse
{
    public Comms: WorkerCommsView;
    public Number: string;
    public Code: string;
    public Message: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<WorkerCommsResponse>) { (Object as any).assign(this, init); }
}

export class DispatchCommsRequest
{
    public MovingMph: number;
    public MovingHoldSecs: number;
    public RelayVoice: boolean;

    public constructor(init?: Partial<DispatchCommsRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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"}}}