Trendsic Platform Service

CourierVansRequest

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


export class CourierMoveTarget
{
    public DriverContactId: number;
    public Name: string;
    public Ok: boolean;
    public Why: string;
    public LeaveByText: string;

    public constructor(init?: Partial<CourierMoveTarget>) { (Object as any).assign(this, init); }
}

export class CourierVanChip
{
    public Code: string;
    public CourierStep: string;
    public LevelCode: string;
    public LevelName: string;
    public Units: number;
    public Area: string;
    public DueUtc?: string;
    public DueText: string;
    public Movable: boolean;
    public NoMoveWhy: string;
    public Targets: CourierMoveTarget[] = [];

    public constructor(init?: Partial<CourierVanChip>) { (Object as any).assign(this, init); }
}

export class CourierOfficeVan
{
    public DriverContactId: number;
    public DriverCode: string;
    public Name: string;
    public Online: boolean;
    public Zone: string;
    public VehicleUnit: string;
    public FacilityName: string;
    public State: string;
    public LeaveByUtc?: string;
    public LeaveByText: string;
    public SlackMin?: number;
    public InVan: number;
    public Committed: number;
    public Cap?: number;
    public CapUnit: string;
    public UnitMany: string;
    public CriticalCode: string;
    public DriveMin: number;
    public SendNote: string;
    public Aboard: CourierVanChip[] = [];
    public Queued: CourierVanChip[] = [];

    public constructor(init?: Partial<CourierOfficeVan>) { (Object as any).assign(this, init); }
}

export class CourierHeldView
{
    public Code: string;
    public Area: string;
    public Units: number;
    public UnitMany: string;
    public Miles?: number;
    public LevelCode: string;
    public LevelName: string;
    public DueText: string;
    public HeldReason: string;
    public HeldMin?: number;
    public Why: string[] = [];
    public BestDriverContactId?: number;
    public BestName: string;
    public BestLeaveByText: string;

    public constructor(init?: Partial<CourierHeldView>) { (Object as any).assign(this, init); }
}

export class CourierVehicleOption
{
    public CourierProfileId: number;
    public EquipmentID: number;
    public UnitNumber: string;
    public VehicleType: string;
    public CapacityUnit: string;
    public CapacityLimit?: number;
    public IsRefrigerated: boolean;
    public Status: string;

    public constructor(init?: Partial<CourierVehicleOption>) { (Object as any).assign(this, init); }
}

export class CourierFacilityOption
{
    public CourierFacilityID: number;
    public Code: string;
    public Name: string;
    public Address: string;
    public IntakeMin: number;

    public constructor(init?: Partial<CourierFacilityOption>) { (Object as any).assign(this, init); }
}

export class CourierProfileOption
{
    public CourierProfileID: number;
    public Name: string;
    public RouteShape: string;
    public Enabled: boolean;
    public UnitOne: string;
    public UnitMany: string;
    public FacilityNoun: string;
    public Facilities: CourierFacilityOption[] = [];

    public constructor(init?: Partial<CourierProfileOption>) { (Object as any).assign(this, init); }
}

export class CourierDriverOption
{
    public ContactId: number;
    public Code: string;
    public Name: string;
    public Online: boolean;
    public Zone: string;
    public VehicleUnit: string;
    public EquipmentID?: number;
    public SentToFacility: boolean;

    public constructor(init?: Partial<CourierDriverOption>) { (Object as any).assign(this, init); }
}

export class CourierDeskRow
{
    public Code: string;
    public CourierProfileId: number;
    public FacilityName: string;
    public LevelCode: string;
    public LevelName: string;
    public DueUtc?: string;
    public DueText: string;
    public Units: number;
    public UnitsFound?: number;
    public UnitMany: string;
    public Fare?: number;
    public FinalPrice?: number;
    public TipAmount?: number;
    public PayMode: string;
    public CaptureMode: string;
    public CustomerName: string;
    public Area: string;
    public IntakeUtc?: string;
    public IntakeMinAgo?: number;
    public DamageNote: string;
    public FinalPriceAfterCount: boolean;
    public NeedsPrice: boolean;
    public ItemCount: number;
    public MissingCount: number;
    public PhotoCount: number;

    public constructor(init?: Partial<CourierDeskRow>) { (Object as any).assign(this, init); }
}

export class CourierOfficeView
{
    public ServerUtc: string;
    public Vans: CourierOfficeVan[] = [];
    public Held: CourierHeldView[] = [];
    public Vehicles: CourierVehicleOption[] = [];
    public Profiles: CourierProfileOption[] = [];
    public Drivers: CourierDriverOption[] = [];
    public Desk: CourierDeskRow[] = [];
    public GoCount: number;
    public HeldCount: number;
    public ReadyToOffer: number;
    public IntakeMin?: number;
    public FacilityNoun: string;

    public constructor(init?: Partial<CourierOfficeView>) { (Object as any).assign(this, init); }
}

export class CourierOfficeResponse
{
    public Office: CourierOfficeView;
    public Available: boolean;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CourierOfficeResponse>) { (Object as any).assign(this, init); }
}

export class CourierVansRequest
{

    public constructor(init?: Partial<CourierVansRequest>) { (Object as any).assign(this, init); }
}

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