Trendsic Platform Service

CourierVansRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/courier/vans

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 CourierMoveTarget() = 
        member val DriverContactId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Ok:Boolean = new Boolean() with get,set
        member val Why:String = null with get,set
        member val LeaveByText:String = null with get,set

    [<AllowNullLiteral>]
    type CourierVanChip() = 
        member val Code:String = null with get,set
        member val CourierStep:String = null with get,set
        member val LevelCode:String = null with get,set
        member val LevelName:String = null with get,set
        member val Units:Int32 = new Int32() with get,set
        member val Area:String = null with get,set
        member val DueUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DueText:String = null with get,set
        member val Movable:Boolean = new Boolean() with get,set
        member val NoMoveWhy:String = null with get,set
        member val Targets:ResizeArray<CourierMoveTarget> = new ResizeArray<CourierMoveTarget>() with get,set

    [<AllowNullLiteral>]
    type CourierOfficeVan() = 
        member val DriverContactId:Int32 = new Int32() with get,set
        member val DriverCode:String = null with get,set
        member val Name:String = null with get,set
        member val Online:Boolean = new Boolean() with get,set
        member val Zone:String = null with get,set
        member val VehicleUnit:String = null with get,set
        member val FacilityName:String = null with get,set
        member val State:String = null with get,set
        member val LeaveByUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LeaveByText:String = null with get,set
        member val SlackMin:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InVan:Int32 = new Int32() with get,set
        member val Committed:Int32 = new Int32() with get,set
        member val Cap:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CapUnit:String = null with get,set
        member val UnitMany:String = null with get,set
        member val CriticalCode:String = null with get,set
        member val DriveMin:Int32 = new Int32() with get,set
        member val SendNote:String = null with get,set
        member val Aboard:ResizeArray<CourierVanChip> = new ResizeArray<CourierVanChip>() with get,set
        member val Queued:ResizeArray<CourierVanChip> = new ResizeArray<CourierVanChip>() with get,set

    [<AllowNullLiteral>]
    type CourierHeldView() = 
        member val Code:String = null with get,set
        member val Area:String = null with get,set
        member val Units:Int32 = new Int32() with get,set
        member val UnitMany:String = null with get,set
        member val Miles:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val LevelCode:String = null with get,set
        member val LevelName:String = null with get,set
        member val DueText:String = null with get,set
        member val HeldReason:String = null with get,set
        member val HeldMin:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Why:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val BestDriverContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val BestName:String = null with get,set
        member val BestLeaveByText:String = null with get,set

    [<AllowNullLiteral>]
    type CourierVehicleOption() = 
        member val CourierProfileId:Int32 = new Int32() with get,set
        member val EquipmentID:Int32 = new Int32() with get,set
        member val UnitNumber:String = null with get,set
        member val VehicleType:String = null with get,set
        member val CapacityUnit:String = null with get,set
        member val CapacityLimit:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val IsRefrigerated:Boolean = new Boolean() with get,set
        member val Status:String = null with get,set

    [<AllowNullLiteral>]
    type CourierFacilityOption() = 
        member val CourierFacilityID:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Address:String = null with get,set
        member val IntakeMin:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CourierProfileOption() = 
        member val CourierProfileID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val RouteShape:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val UnitOne:String = null with get,set
        member val UnitMany:String = null with get,set
        member val FacilityNoun:String = null with get,set
        member val Facilities:ResizeArray<CourierFacilityOption> = new ResizeArray<CourierFacilityOption>() with get,set

    [<AllowNullLiteral>]
    type CourierDriverOption() = 
        member val ContactId:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Online:Boolean = new Boolean() with get,set
        member val Zone:String = null with get,set
        member val VehicleUnit:String = null with get,set
        member val EquipmentID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SentToFacility:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierDeskRow() = 
        member val Code:String = null with get,set
        member val CourierProfileId:Int32 = new Int32() with get,set
        member val FacilityName:String = null with get,set
        member val LevelCode:String = null with get,set
        member val LevelName:String = null with get,set
        member val DueUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DueText:String = null with get,set
        member val Units:Int32 = new Int32() with get,set
        member val UnitsFound:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UnitMany:String = null with get,set
        member val Fare:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val FinalPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TipAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PayMode:String = null with get,set
        member val CaptureMode:String = null with get,set
        member val CustomerName:String = null with get,set
        member val Area:String = null with get,set
        member val IntakeUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IntakeMinAgo:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DamageNote:String = null with get,set
        member val FinalPriceAfterCount:Boolean = new Boolean() with get,set
        member val NeedsPrice:Boolean = new Boolean() with get,set
        member val ItemCount:Int32 = new Int32() with get,set
        member val MissingCount:Int32 = new Int32() with get,set
        member val PhotoCount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CourierOfficeView() = 
        member val ServerUtc:DateTime = new DateTime() with get,set
        member val Vans:ResizeArray<CourierOfficeVan> = new ResizeArray<CourierOfficeVan>() with get,set
        member val Held:ResizeArray<CourierHeldView> = new ResizeArray<CourierHeldView>() with get,set
        member val Vehicles:ResizeArray<CourierVehicleOption> = new ResizeArray<CourierVehicleOption>() with get,set
        member val Profiles:ResizeArray<CourierProfileOption> = new ResizeArray<CourierProfileOption>() with get,set
        member val Drivers:ResizeArray<CourierDriverOption> = new ResizeArray<CourierDriverOption>() with get,set
        member val Desk:ResizeArray<CourierDeskRow> = new ResizeArray<CourierDeskRow>() with get,set
        member val GoCount:Int32 = new Int32() with get,set
        member val HeldCount:Int32 = new Int32() with get,set
        member val ReadyToOffer:Int32 = new Int32() with get,set
        member val IntakeMin:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FacilityNoun:String = null with get,set

    [<AllowNullLiteral>]
    type CourierOfficeResponse() = 
        member val Office:CourierOfficeView = null with get,set
        member val Available:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CourierVansRequest() = 
        class end

F# CourierVansRequest 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/dispatch/courier/vans HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierOfficeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Available>false</Available>
  <Office>
    <Desk>
      <CourierDeskRow>
        <Area>String</Area>
        <CaptureMode>String</CaptureMode>
        <Code>String</Code>
        <CourierProfileId>0</CourierProfileId>
        <CustomerName>String</CustomerName>
        <DamageNote>String</DamageNote>
        <DueText>String</DueText>
        <DueUtc>0001-01-01T00:00:00</DueUtc>
        <FacilityName>String</FacilityName>
        <Fare>0</Fare>
        <FinalPrice>0</FinalPrice>
        <FinalPriceAfterCount>false</FinalPriceAfterCount>
        <IntakeMinAgo>0</IntakeMinAgo>
        <IntakeUtc>0001-01-01T00:00:00</IntakeUtc>
        <ItemCount>0</ItemCount>
        <LevelCode>String</LevelCode>
        <LevelName>String</LevelName>
        <MissingCount>0</MissingCount>
        <NeedsPrice>false</NeedsPrice>
        <PayMode>String</PayMode>
        <PhotoCount>0</PhotoCount>
        <TipAmount>0</TipAmount>
        <UnitMany>String</UnitMany>
        <Units>0</Units>
        <UnitsFound>0</UnitsFound>
      </CourierDeskRow>
    </Desk>
    <Drivers>
      <CourierDriverOption>
        <Code>String</Code>
        <ContactId>0</ContactId>
        <EquipmentID>0</EquipmentID>
        <Name>String</Name>
        <Online>false</Online>
        <SentToFacility>false</SentToFacility>
        <VehicleUnit>String</VehicleUnit>
        <Zone>String</Zone>
      </CourierDriverOption>
    </Drivers>
    <FacilityNoun>String</FacilityNoun>
    <GoCount>0</GoCount>
    <Held>
      <CourierHeldView>
        <Area>String</Area>
        <BestDriverContactId>0</BestDriverContactId>
        <BestLeaveByText>String</BestLeaveByText>
        <BestName>String</BestName>
        <Code>String</Code>
        <DueText>String</DueText>
        <HeldMin>0</HeldMin>
        <HeldReason>String</HeldReason>
        <LevelCode>String</LevelCode>
        <LevelName>String</LevelName>
        <Miles>0</Miles>
        <UnitMany>String</UnitMany>
        <Units>0</Units>
        <Why xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Why>
      </CourierHeldView>
    </Held>
    <HeldCount>0</HeldCount>
    <IntakeMin>0</IntakeMin>
    <Profiles>
      <CourierProfileOption>
        <CourierProfileID>0</CourierProfileID>
        <Enabled>false</Enabled>
        <Facilities>
          <CourierFacilityOption>
            <Address>String</Address>
            <Code>String</Code>
            <CourierFacilityID>0</CourierFacilityID>
            <IntakeMin>0</IntakeMin>
            <Name>String</Name>
          </CourierFacilityOption>
        </Facilities>
        <FacilityNoun>String</FacilityNoun>
        <Name>String</Name>
        <RouteShape>String</RouteShape>
        <UnitMany>String</UnitMany>
        <UnitOne>String</UnitOne>
      </CourierProfileOption>
    </Profiles>
    <ReadyToOffer>0</ReadyToOffer>
    <ServerUtc>0001-01-01T00:00:00</ServerUtc>
    <Vans>
      <CourierOfficeVan>
        <Aboard>
          <CourierVanChip>
            <Area>String</Area>
            <Code>String</Code>
            <CourierStep>String</CourierStep>
            <DueText>String</DueText>
            <DueUtc>0001-01-01T00:00:00</DueUtc>
            <LevelCode>String</LevelCode>
            <LevelName>String</LevelName>
            <Movable>false</Movable>
            <NoMoveWhy>String</NoMoveWhy>
            <Targets>
              <CourierMoveTarget>
                <DriverContactId>0</DriverContactId>
                <LeaveByText>String</LeaveByText>
                <Name>String</Name>
                <Ok>false</Ok>
                <Why>String</Why>
              </CourierMoveTarget>
            </Targets>
            <Units>0</Units>
          </CourierVanChip>
        </Aboard>
        <Cap>0</Cap>
        <CapUnit>String</CapUnit>
        <Committed>0</Committed>
        <CriticalCode>String</CriticalCode>
        <DriveMin>0</DriveMin>
        <DriverCode>String</DriverCode>
        <DriverContactId>0</DriverContactId>
        <FacilityName>String</FacilityName>
        <InVan>0</InVan>
        <LeaveByText>String</LeaveByText>
        <LeaveByUtc>0001-01-01T00:00:00</LeaveByUtc>
        <Name>String</Name>
        <Online>false</Online>
        <Queued>
          <CourierVanChip>
            <Area>String</Area>
            <Code>String</Code>
            <CourierStep>String</CourierStep>
            <DueText>String</DueText>
            <DueUtc>0001-01-01T00:00:00</DueUtc>
            <LevelCode>String</LevelCode>
            <LevelName>String</LevelName>
            <Movable>false</Movable>
            <NoMoveWhy>String</NoMoveWhy>
            <Targets>
              <CourierMoveTarget>
                <DriverContactId>0</DriverContactId>
                <LeaveByText>String</LeaveByText>
                <Name>String</Name>
                <Ok>false</Ok>
                <Why>String</Why>
              </CourierMoveTarget>
            </Targets>
            <Units>0</Units>
          </CourierVanChip>
        </Queued>
        <SendNote>String</SendNote>
        <SlackMin>0</SlackMin>
        <State>String</State>
        <UnitMany>String</UnitMany>
        <VehicleUnit>String</VehicleUnit>
        <Zone>String</Zone>
      </CourierOfficeVan>
    </Vans>
    <Vehicles>
      <CourierVehicleOption>
        <CapacityLimit>0</CapacityLimit>
        <CapacityUnit>String</CapacityUnit>
        <CourierProfileId>0</CourierProfileId>
        <EquipmentID>0</EquipmentID>
        <IsRefrigerated>false</IsRefrigerated>
        <Status>String</Status>
        <UnitNumber>String</UnitNumber>
        <VehicleType>String</VehicleType>
      </CourierVehicleOption>
    </Vehicles>
  </Office>
  <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>
</CourierOfficeResponse>