Trendsic Platform Service

CourierVansRequest

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class CourierDeskRow
            Public Overridable Property Code As String
            Public Overridable Property CourierProfileId As Integer
            Public Overridable Property FacilityName As String
            Public Overridable Property LevelCode As String
            Public Overridable Property LevelName As String
            Public Overridable Property DueUtc As Date?
            Public Overridable Property DueText As String
            Public Overridable Property Units As Integer
            Public Overridable Property UnitsFound As Integer?
            Public Overridable Property UnitMany As String
            Public Overridable Property Fare As Decimal?
            Public Overridable Property FinalPrice As Decimal?
            Public Overridable Property TipAmount As Decimal?
            Public Overridable Property PayMode As String
            Public Overridable Property CaptureMode As String
            Public Overridable Property CustomerName As String
            Public Overridable Property Area As String
            Public Overridable Property IntakeUtc As Date?
            Public Overridable Property IntakeMinAgo As Integer?
            Public Overridable Property DamageNote As String
            Public Overridable Property FinalPriceAfterCount As Boolean
            Public Overridable Property NeedsPrice As Boolean
            Public Overridable Property ItemCount As Integer
            Public Overridable Property MissingCount As Integer
            Public Overridable Property PhotoCount As Integer
        End Class

        Public Partial Class CourierDriverOption
            Public Overridable Property ContactId As Integer
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Online As Boolean
            Public Overridable Property Zone As String
            Public Overridable Property VehicleUnit As String
            Public Overridable Property EquipmentID As Integer?
            Public Overridable Property SentToFacility As Boolean
        End Class

        Public Partial Class CourierFacilityOption
            Public Overridable Property CourierFacilityID As Integer
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Address As String
            Public Overridable Property IntakeMin As Integer
        End Class

        Public Partial Class CourierHeldView
            Public Overridable Property Code As String
            Public Overridable Property Area As String
            Public Overridable Property Units As Integer
            Public Overridable Property UnitMany As String
            Public Overridable Property Miles As Decimal?
            Public Overridable Property LevelCode As String
            Public Overridable Property LevelName As String
            Public Overridable Property DueText As String
            Public Overridable Property HeldReason As String
            Public Overridable Property HeldMin As Integer?
            Public Overridable Property Why As List(Of String) = New List(Of String)
            Public Overridable Property BestDriverContactId As Integer?
            Public Overridable Property BestName As String
            Public Overridable Property BestLeaveByText As String
        End Class

        Public Partial Class CourierMoveTarget
            Public Overridable Property DriverContactId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Ok As Boolean
            Public Overridable Property Why As String
            Public Overridable Property LeaveByText As String
        End Class

        Public Partial Class CourierOfficeResponse
            Public Overridable Property Office As CourierOfficeView
            Public Overridable Property Available As Boolean
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class CourierOfficeVan
            Public Overridable Property DriverContactId As Integer
            Public Overridable Property DriverCode As String
            Public Overridable Property Name As String
            Public Overridable Property Online As Boolean
            Public Overridable Property Zone As String
            Public Overridable Property VehicleUnit As String
            Public Overridable Property FacilityName As String
            Public Overridable Property State As String
            Public Overridable Property LeaveByUtc As Date?
            Public Overridable Property LeaveByText As String
            Public Overridable Property SlackMin As Integer?
            Public Overridable Property InVan As Integer
            Public Overridable Property Committed As Integer
            Public Overridable Property Cap As Decimal?
            Public Overridable Property CapUnit As String
            Public Overridable Property UnitMany As String
            Public Overridable Property CriticalCode As String
            Public Overridable Property DriveMin As Integer
            Public Overridable Property SendNote As String
            Public Overridable Property Aboard As List(Of CourierVanChip) = New List(Of CourierVanChip)
            Public Overridable Property Queued As List(Of CourierVanChip) = New List(Of CourierVanChip)
        End Class

        Public Partial Class CourierOfficeView
            Public Overridable Property ServerUtc As Date
            Public Overridable Property Vans As List(Of CourierOfficeVan) = New List(Of CourierOfficeVan)
            Public Overridable Property Held As List(Of CourierHeldView) = New List(Of CourierHeldView)
            Public Overridable Property Vehicles As List(Of CourierVehicleOption) = New List(Of CourierVehicleOption)
            Public Overridable Property Profiles As List(Of CourierProfileOption) = New List(Of CourierProfileOption)
            Public Overridable Property Drivers As List(Of CourierDriverOption) = New List(Of CourierDriverOption)
            Public Overridable Property Desk As List(Of CourierDeskRow) = New List(Of CourierDeskRow)
            Public Overridable Property GoCount As Integer
            Public Overridable Property HeldCount As Integer
            Public Overridable Property ReadyToOffer As Integer
            Public Overridable Property IntakeMin As Integer?
            Public Overridable Property FacilityNoun As String
        End Class

        Public Partial Class CourierProfileOption
            Public Overridable Property CourierProfileID As Integer
            Public Overridable Property Name As String
            Public Overridable Property RouteShape As String
            Public Overridable Property Enabled As Boolean
            Public Overridable Property UnitOne As String
            Public Overridable Property UnitMany As String
            Public Overridable Property FacilityNoun As String
            Public Overridable Property Facilities As List(Of CourierFacilityOption) = New List(Of CourierFacilityOption)
        End Class

        Public Partial Class CourierVanChip
            Public Overridable Property Code As String
            Public Overridable Property CourierStep As String
            Public Overridable Property LevelCode As String
            Public Overridable Property LevelName As String
            Public Overridable Property Units As Integer
            Public Overridable Property Area As String
            Public Overridable Property DueUtc As Date?
            Public Overridable Property DueText As String
            Public Overridable Property Movable As Boolean
            Public Overridable Property NoMoveWhy As String
            Public Overridable Property Targets As List(Of CourierMoveTarget) = New List(Of CourierMoveTarget)
        End Class

        Public Partial Class CourierVansRequest
        End Class

        Public Partial Class CourierVehicleOption
            Public Overridable Property CourierProfileId As Integer
            Public Overridable Property EquipmentID As Integer
            Public Overridable Property UnitNumber As String
            Public Overridable Property VehicleType As String
            Public Overridable Property CapacityUnit As String
            Public Overridable Property CapacityLimit As Decimal?
            Public Overridable Property IsRefrigerated As Boolean
            Public Overridable Property Status As String
        End Class
    End Namespace
End Namespace

VB.NET 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>