Trendsic Platform Service

CourierVansRequest

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CourierVansRequest
{
}

open class CourierOfficeResponse
{
    open var Office:CourierOfficeView? = null
    open var Available:Boolean? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CourierOfficeView
{
    open var ServerUtc:Date? = null
    open var Vans:ArrayList<CourierOfficeVan> = ArrayList<CourierOfficeVan>()
    open var Held:ArrayList<CourierHeldView> = ArrayList<CourierHeldView>()
    open var Vehicles:ArrayList<CourierVehicleOption> = ArrayList<CourierVehicleOption>()
    open var Profiles:ArrayList<CourierProfileOption> = ArrayList<CourierProfileOption>()
    open var Drivers:ArrayList<CourierDriverOption> = ArrayList<CourierDriverOption>()
    open var Desk:ArrayList<CourierDeskRow> = ArrayList<CourierDeskRow>()
    open var GoCount:Int? = null
    open var HeldCount:Int? = null
    open var ReadyToOffer:Int? = null
    open var IntakeMin:Int? = null
    open var FacilityNoun:String? = null
}

open class CourierOfficeVan
{
    open var DriverContactId:Int? = null
    open var DriverCode:String? = null
    open var Name:String? = null
    open var Online:Boolean? = null
    open var Zone:String? = null
    open var VehicleUnit:String? = null
    open var FacilityName:String? = null
    open var State:String? = null
    open var LeaveByUtc:Date? = null
    open var LeaveByText:String? = null
    open var SlackMin:Int? = null
    open var InVan:Int? = null
    open var Committed:Int? = null
    open var Cap:BigDecimal? = null
    open var CapUnit:String? = null
    open var UnitMany:String? = null
    open var CriticalCode:String? = null
    open var DriveMin:Int? = null
    open var SendNote:String? = null
    open var Aboard:ArrayList<CourierVanChip> = ArrayList<CourierVanChip>()
    open var Queued:ArrayList<CourierVanChip> = ArrayList<CourierVanChip>()
}

open class CourierVanChip
{
    open var Code:String? = null
    open var CourierStep:String? = null
    open var LevelCode:String? = null
    open var LevelName:String? = null
    open var Units:Int? = null
    open var Area:String? = null
    open var DueUtc:Date? = null
    open var DueText:String? = null
    open var Movable:Boolean? = null
    open var NoMoveWhy:String? = null
    open var Targets:ArrayList<CourierMoveTarget> = ArrayList<CourierMoveTarget>()
}

open class CourierMoveTarget
{
    open var DriverContactId:Int? = null
    open var Name:String? = null
    open var Ok:Boolean? = null
    open var Why:String? = null
    open var LeaveByText:String? = null
}

open class CourierHeldView
{
    open var Code:String? = null
    open var Area:String? = null
    open var Units:Int? = null
    open var UnitMany:String? = null
    open var Miles:BigDecimal? = null
    open var LevelCode:String? = null
    open var LevelName:String? = null
    open var DueText:String? = null
    open var HeldReason:String? = null
    open var HeldMin:Int? = null
    open var Why:ArrayList<String> = ArrayList<String>()
    open var BestDriverContactId:Int? = null
    open var BestName:String? = null
    open var BestLeaveByText:String? = null
}

open class CourierVehicleOption
{
    open var CourierProfileId:Int? = null
    open var EquipmentID:Int? = null
    open var UnitNumber:String? = null
    open var VehicleType:String? = null
    open var CapacityUnit:String? = null
    open var CapacityLimit:BigDecimal? = null
    open var IsRefrigerated:Boolean? = null
    open var Status:String? = null
}

open class CourierProfileOption
{
    open var CourierProfileID:Int? = null
    open var Name:String? = null
    open var RouteShape:String? = null
    open var Enabled:Boolean? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var FacilityNoun:String? = null
    open var Facilities:ArrayList<CourierFacilityOption> = ArrayList<CourierFacilityOption>()
}

open class CourierFacilityOption
{
    open var CourierFacilityID:Int? = null
    open var Code:String? = null
    open var Name:String? = null
    open var Address:String? = null
    open var IntakeMin:Int? = null
}

open class CourierDriverOption
{
    open var ContactId:Int? = null
    open var Code:String? = null
    open var Name:String? = null
    open var Online:Boolean? = null
    open var Zone:String? = null
    open var VehicleUnit:String? = null
    open var EquipmentID:Int? = null
    open var SentToFacility:Boolean? = null
}

open class CourierDeskRow
{
    open var Code:String? = null
    open var CourierProfileId:Int? = null
    open var FacilityName:String? = null
    open var LevelCode:String? = null
    open var LevelName:String? = null
    open var DueUtc:Date? = null
    open var DueText:String? = null
    open var Units:Int? = null
    open var UnitsFound:Int? = null
    open var UnitMany:String? = null
    open var Fare:BigDecimal? = null
    open var FinalPrice:BigDecimal? = null
    open var TipAmount:BigDecimal? = null
    open var PayMode:String? = null
    open var CaptureMode:String? = null
    open var CustomerName:String? = null
    open var Area:String? = null
    open var IntakeUtc:Date? = null
    open var IntakeMinAgo:Int? = null
    open var DamageNote:String? = null
    open var FinalPriceAfterCount:Boolean? = null
    open var NeedsPrice:Boolean? = null
    open var ItemCount:Int? = null
    open var MissingCount:Int? = null
    open var PhotoCount:Int? = null
}

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