Trendsic Platform Service

<back to all web services

RoutePlanOptimizeRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/routeplan/optimize
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 RoutePlanOptimizeAssignment() = 
        member val AgreementID:Int32 = new Int32() with get,set
        member val CrewID:Int32 = new Int32() with get,set
        member val Seq:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type RoutePlanOptimizeResponse() = 
        member val Assignments:ResizeArray<RoutePlanOptimizeAssignment> = new ResizeArray<RoutePlanOptimizeAssignment>() with get,set
        member val ByDefaultCrew:Int32 = new Int32() with get,set
        member val ByTerritory:Int32 = new Int32() with get,set
        member val SkippedHeld:Int32 = new Int32() with get,set
        member val Engine:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type RoutePlanOptimizeRequest() = 
        member val DateIso:String = null with get,set
        member val HoldDays:Int32 = new Int32() with get,set

F# RoutePlanOptimizeRequest 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/routeplan/optimize HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<RoutePlanOptimizeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Assignments>
    <RoutePlanOptimizeAssignment>
      <AgreementID>0</AgreementID>
      <CrewID>0</CrewID>
      <Seq>0</Seq>
    </RoutePlanOptimizeAssignment>
  </Assignments>
  <ByDefaultCrew>0</ByDefaultCrew>
  <ByTerritory>0</ByTerritory>
  <Engine>String</Engine>
  <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>
  <SkippedHeld>0</SkippedHeld>
</RoutePlanOptimizeResponse>