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