Trendsic Platform Service

<back to all web services

DispatchCommsRequest

Requires Authentication
The following routes are available for this service:
GET,PUT/v1/dispatch/comms
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DispatchCommsRequest
{
    open var MovingMph:BigDecimal? = null
    open var MovingHoldSecs:Int? = null
    open var RelayVoice:Boolean? = null
}

open class WorkerCommsResponse
{
    open var Comms:WorkerCommsView? = null
    open var Number:String? = null
    open var Code:String? = null
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class WorkerCommsView
{
    open var MovingMph:BigDecimal? = null
    open var MovingHoldSecs:Int? = null
    open var RelayVoice:Boolean? = null
    open var RelayReady:Boolean? = null
    open var HasOwnNumber:Boolean? = null
    open var RelayNumber:String? = null
}

Kotlin DispatchCommsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

<DispatchCommsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <MovingHoldSecs>0</MovingHoldSecs>
  <MovingMph>0</MovingMph>
  <RelayVoice>false</RelayVoice>
</DispatchCommsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkerCommsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Code>String</Code>
  <Comms>
    <HasOwnNumber>false</HasOwnNumber>
    <MovingHoldSecs>0</MovingHoldSecs>
    <MovingMph>0</MovingMph>
    <RelayNumber>String</RelayNumber>
    <RelayReady>false</RelayReady>
    <RelayVoice>false</RelayVoice>
  </Comms>
  <Message>String</Message>
  <Number>String</Number>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</WorkerCommsResponse>