Trendsic Platform Service

<back to all web services

DispatchCommsRequest

Requires Authentication
The following routes are available for this service:
GET,PUT/v1/dispatch/comms
DispatchCommsRequest Parameters:
NameParameterData TypeRequiredDescription
MovingMphbodydecimalNo
MovingHoldSecsbodyintNo
RelayVoicebodyboolNo
WorkerCommsResponse Parameters:
NameParameterData TypeRequiredDescription
CommsformWorkerCommsViewNo
NumberformstringNo
CodeformstringNo
MessageformstringNo
ResponseStatusformResponseStatusNo
WorkerCommsView Parameters:
NameParameterData TypeRequiredDescription
MovingMphformdecimalNo
MovingHoldSecsformintNo
RelayVoiceformboolNo
RelayReadyformboolNo
HasOwnNumberformboolNo
RelayNumberformstringNo

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.

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