Trendsic Platform Service

<back to all web services

DispatchCommsRequest

Requires Authentication
The following routes are available for this service:
GET,PUT/v1/dispatch/comms
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WorkerCommsView() = 
        member val MovingMph:Decimal = new Decimal() with get,set
        member val MovingHoldSecs:Int32 = new Int32() with get,set
        member val RelayVoice:Boolean = new Boolean() with get,set
        member val RelayReady:Boolean = new Boolean() with get,set
        member val HasOwnNumber:Boolean = new Boolean() with get,set
        member val RelayNumber:String = null with get,set

    [<AllowNullLiteral>]
    type WorkerCommsResponse() = 
        member val Comms:WorkerCommsView = null with get,set
        member val Number:String = null with get,set
        member val Code:String = null with get,set
        member val Message:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DispatchCommsRequest() = 
        member val MovingMph:Decimal = new Decimal() with get,set
        member val MovingHoldSecs:Int32 = new Int32() with get,set
        member val RelayVoice:Boolean = new Boolean() with get,set

F# 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>