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 'package:servicestack/servicestack.dart';

class WorkerCommsView implements IConvertible
{
    double? MovingMph;
    int? MovingHoldSecs;
    bool? RelayVoice;
    bool? RelayReady;
    bool? HasOwnNumber;
    String? RelayNumber;

    WorkerCommsView({this.MovingMph,this.MovingHoldSecs,this.RelayVoice,this.RelayReady,this.HasOwnNumber,this.RelayNumber});
    WorkerCommsView.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MovingMph = JsonConverters.toDouble(json['MovingMph']);
        MovingHoldSecs = json['MovingHoldSecs'];
        RelayVoice = json['RelayVoice'];
        RelayReady = json['RelayReady'];
        HasOwnNumber = json['HasOwnNumber'];
        RelayNumber = json['RelayNumber'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MovingMph': MovingMph,
        'MovingHoldSecs': MovingHoldSecs,
        'RelayVoice': RelayVoice,
        'RelayReady': RelayReady,
        'HasOwnNumber': HasOwnNumber,
        'RelayNumber': RelayNumber
    };

    getTypeName() => "WorkerCommsView";
    TypeContext? context = _ctx;
}

class WorkerCommsResponse implements IConvertible
{
    WorkerCommsView? Comms;
    String? Number;
    String? Code;
    String? Message;
    ResponseStatus? ResponseStatus;

    WorkerCommsResponse({this.Comms,this.Number,this.Code,this.Message,this.ResponseStatus});
    WorkerCommsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Comms = JsonConverters.fromJson(json['Comms'],'WorkerCommsView',context!);
        Number = json['Number'];
        Code = json['Code'];
        Message = json['Message'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Comms': JsonConverters.toJson(Comms,'WorkerCommsView',context!),
        'Number': Number,
        'Code': Code,
        'Message': Message,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "WorkerCommsResponse";
    TypeContext? context = _ctx;
}

class DispatchCommsRequest implements IConvertible
{
    double? MovingMph;
    int? MovingHoldSecs;
    bool? RelayVoice;

    DispatchCommsRequest({this.MovingMph,this.MovingHoldSecs,this.RelayVoice});
    DispatchCommsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MovingMph = JsonConverters.toDouble(json['MovingMph']);
        MovingHoldSecs = json['MovingHoldSecs'];
        RelayVoice = json['RelayVoice'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MovingMph': MovingMph,
        'MovingHoldSecs': MovingHoldSecs,
        'RelayVoice': RelayVoice
    };

    getTypeName() => "DispatchCommsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'WorkerCommsView': TypeInfo(TypeOf.Class, create:() => WorkerCommsView()),
    'WorkerCommsResponse': TypeInfo(TypeOf.Class, create:() => WorkerCommsResponse()),
    'DispatchCommsRequest': TypeInfo(TypeOf.Class, create:() => DispatchCommsRequest()),
});

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