| GET,PUT | /v1/dispatch/comms |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MovingMph | body | decimal | No | |
| MovingHoldSecs | body | int | No | |
| RelayVoice | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Comms | form | WorkerCommsView | No | |
| Number | form | string | No | |
| Code | form | string | No | |
| Message | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MovingMph | form | decimal | No | |
| MovingHoldSecs | form | int | No | |
| RelayVoice | form | bool | No | |
| RelayReady | form | bool | No | |
| HasOwnNumber | form | bool | No | |
| RelayNumber | form | string | No |
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
}
}
}