Trendsic Platform Service

<back to all web services

VisitOptimizeRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/visits/optimize
import 'package:servicestack/servicestack.dart';

class VisitActionResponse implements IConvertible
{
    bool? Success;
    String? Message;
    int? Affected;
    ResponseStatus? ResponseStatus;

    VisitActionResponse({this.Success,this.Message,this.Affected,this.ResponseStatus});
    VisitActionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Success': Success,
        'Message': Message,
        'Affected': Affected,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class VisitOptimizeRequest implements IConvertible
{
    int? CrewID;
    String? Date;
    double? StartLat;
    double? StartLng;

    VisitOptimizeRequest({this.CrewID,this.Date,this.StartLat,this.StartLng});
    VisitOptimizeRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CrewID = json['CrewID'];
        Date = json['Date'];
        StartLat = JsonConverters.toDouble(json['StartLat']);
        StartLng = JsonConverters.toDouble(json['StartLng']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CrewID': CrewID,
        'Date': Date,
        'StartLat': StartLat,
        'StartLng': StartLng
    };

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

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

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

POST /v1/visits/optimize HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<VisitOptimizeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CrewID>0</CrewID>
  <Date>String</Date>
  <StartLat>0</StartLat>
  <StartLng>0</StartLng>
</VisitOptimizeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VisitActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Affected>0</Affected>
  <Message>String</Message>
  <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>
  <Success>false</Success>
</VisitActionResponse>