Trendsic Platform Service

<back to all web services

RoutePlanWeekRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/routeplan/week
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 RoutePlanCrew() = 
        member val CrewID:Int32 = new Int32() with get,set
        member val CrewName:String = null with get,set
        member val CrewColor:String = null with get,set
        member val HomeZip:String = null with get,set
        member val YardLat:Nullable<Double> = new Nullable<Double>() with get,set
        member val YardLng:Nullable<Double> = new Nullable<Double>() with get,set
        member val DailyCapacityMin:Int32 = new Int32() with get,set
        member val WeeklyCapacityMin:Int32 = new Int32() with get,set
        member val Specialist:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RoutePlanVisit() = 
        member val AgreementID:Int32 = new Int32() with get,set
        member val AgreementJobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Name:String = null with get,set
        member val Sub:String = null with get,set
        member val ServiceType:String = null with get,set
        member val Zip:String = null with get,set
        member val Area:String = null with get,set
        member val Lat:Nullable<Double> = new Nullable<Double>() with get,set
        member val Lng:Nullable<Double> = new Nullable<Double>() with get,set
        member val DurationMin:Int32 = new Int32() with get,set
        member val DueIso:String = null with get,set
        member val DueLabel:String = null with get,set
        member val Overdue:Boolean = new Boolean() with get,set
        member val DefaultCrewID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RouteCrewID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RouteSeq:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RouteDateIso:String = null with get,set
        member val LateDays:Int32 = new Int32() with get,set
        member val AutoPay:Boolean = new Boolean() with get,set
        member val SkipPolicy:String = null with get,set
        member val SkipCreditAmount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type RoutePlanSkippedVisit() = 
        member val AgreementJobID:Int32 = new Int32() with get,set
        member val AgreementID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val DateIso:String = null with get,set
        member val Reason:String = null with get,set
        member val CreditAmount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type RoutePlanWeekResponse() = 
        member val FromIso:String = null with get,set
        member val ToIso:String = null with get,set
        member val Crews:ResizeArray<RoutePlanCrew> = new ResizeArray<RoutePlanCrew>() with get,set
        member val Visits:ResizeArray<RoutePlanVisit> = new ResizeArray<RoutePlanVisit>() with get,set
        member val Skipped:ResizeArray<RoutePlanSkippedVisit> = new ResizeArray<RoutePlanSkippedVisit>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type RoutePlanWeekRequest() = 
        member val From:String = null with get,set

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

GET /v1/routeplan/week HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RoutePlanWeekResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Crews>
    <RoutePlanCrew>
      <CrewColor>String</CrewColor>
      <CrewID>0</CrewID>
      <CrewName>String</CrewName>
      <DailyCapacityMin>0</DailyCapacityMin>
      <HomeZip>String</HomeZip>
      <Specialist>false</Specialist>
      <WeeklyCapacityMin>0</WeeklyCapacityMin>
      <YardLat>0</YardLat>
      <YardLng>0</YardLng>
    </RoutePlanCrew>
  </Crews>
  <FromIso>String</FromIso>
  <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>
  <Skipped>
    <RoutePlanSkippedVisit>
      <AgreementID>0</AgreementID>
      <AgreementJobID>0</AgreementJobID>
      <CreditAmount>0</CreditAmount>
      <DateIso>String</DateIso>
      <Name>String</Name>
      <Reason>String</Reason>
    </RoutePlanSkippedVisit>
  </Skipped>
  <ToIso>String</ToIso>
  <Visits>
    <RoutePlanVisit>
      <AgreementID>0</AgreementID>
      <AgreementJobID>0</AgreementJobID>
      <Area>String</Area>
      <AutoPay>false</AutoPay>
      <DefaultCrewID>0</DefaultCrewID>
      <DueIso>String</DueIso>
      <DueLabel>String</DueLabel>
      <DurationMin>0</DurationMin>
      <Lat>0</Lat>
      <LateDays>0</LateDays>
      <Lng>0</Lng>
      <Name>String</Name>
      <Overdue>false</Overdue>
      <RouteCrewID>0</RouteCrewID>
      <RouteDateIso>String</RouteDateIso>
      <RouteSeq>0</RouteSeq>
      <ServiceType>String</ServiceType>
      <SkipCreditAmount>0</SkipCreditAmount>
      <SkipPolicy>String</SkipPolicy>
      <Sub>String</Sub>
      <Zip>String</Zip>
    </RoutePlanVisit>
  </Visits>
</RoutePlanWeekResponse>