Trendsic Platform Service

<back to all web services

CourierVansRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/courier/vans
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class CourierDeskRow
    {
        public virtual string Code { get; set; }
        public virtual int CourierProfileId { get; set; }
        public virtual string FacilityName { get; set; }
        public virtual string LevelCode { get; set; }
        public virtual string LevelName { get; set; }
        public virtual DateTime? DueUtc { get; set; }
        public virtual string DueText { get; set; }
        public virtual int Units { get; set; }
        public virtual int? UnitsFound { get; set; }
        public virtual string UnitMany { get; set; }
        public virtual decimal? Fare { get; set; }
        public virtual decimal? FinalPrice { get; set; }
        public virtual decimal? TipAmount { get; set; }
        public virtual string PayMode { get; set; }
        public virtual string CaptureMode { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string Area { get; set; }
        public virtual DateTime? IntakeUtc { get; set; }
        public virtual int? IntakeMinAgo { get; set; }
        public virtual string DamageNote { get; set; }
        public virtual bool FinalPriceAfterCount { get; set; }
        public virtual bool NeedsPrice { get; set; }
        public virtual int ItemCount { get; set; }
        public virtual int MissingCount { get; set; }
        public virtual int PhotoCount { get; set; }
    }

    public partial class CourierDriverOption
    {
        public virtual int ContactId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual bool Online { get; set; }
        public virtual string Zone { get; set; }
        public virtual string VehicleUnit { get; set; }
        public virtual int? EquipmentID { get; set; }
        public virtual bool SentToFacility { get; set; }
    }

    public partial class CourierFacilityOption
    {
        public virtual int CourierFacilityID { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Address { get; set; }
        public virtual int IntakeMin { get; set; }
    }

    public partial class CourierHeldView
    {
        public virtual string Code { get; set; }
        public virtual string Area { get; set; }
        public virtual int Units { get; set; }
        public virtual string UnitMany { get; set; }
        public virtual decimal? Miles { get; set; }
        public virtual string LevelCode { get; set; }
        public virtual string LevelName { get; set; }
        public virtual string DueText { get; set; }
        public virtual string HeldReason { get; set; }
        public virtual int? HeldMin { get; set; }
        public virtual List<string> Why { get; set; } = [];
        public virtual int? BestDriverContactId { get; set; }
        public virtual string BestName { get; set; }
        public virtual string BestLeaveByText { get; set; }
    }

    public partial class CourierMoveTarget
    {
        public virtual int DriverContactId { get; set; }
        public virtual string Name { get; set; }
        public virtual bool Ok { get; set; }
        public virtual string Why { get; set; }
        public virtual string LeaveByText { get; set; }
    }

    public partial class CourierOfficeResponse
    {
        public virtual CourierOfficeView Office { get; set; }
        public virtual bool Available { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class CourierOfficeVan
    {
        public virtual int DriverContactId { get; set; }
        public virtual string DriverCode { get; set; }
        public virtual string Name { get; set; }
        public virtual bool Online { get; set; }
        public virtual string Zone { get; set; }
        public virtual string VehicleUnit { get; set; }
        public virtual string FacilityName { get; set; }
        public virtual string State { get; set; }
        public virtual DateTime? LeaveByUtc { get; set; }
        public virtual string LeaveByText { get; set; }
        public virtual int? SlackMin { get; set; }
        public virtual int InVan { get; set; }
        public virtual int Committed { get; set; }
        public virtual decimal? Cap { get; set; }
        public virtual string CapUnit { get; set; }
        public virtual string UnitMany { get; set; }
        public virtual string CriticalCode { get; set; }
        public virtual int DriveMin { get; set; }
        public virtual string SendNote { get; set; }
        public virtual List<CourierVanChip> Aboard { get; set; } = [];
        public virtual List<CourierVanChip> Queued { get; set; } = [];
    }

    public partial class CourierOfficeView
    {
        public virtual DateTime ServerUtc { get; set; }
        public virtual List<CourierOfficeVan> Vans { get; set; } = [];
        public virtual List<CourierHeldView> Held { get; set; } = [];
        public virtual List<CourierVehicleOption> Vehicles { get; set; } = [];
        public virtual List<CourierProfileOption> Profiles { get; set; } = [];
        public virtual List<CourierDriverOption> Drivers { get; set; } = [];
        public virtual List<CourierDeskRow> Desk { get; set; } = [];
        public virtual int GoCount { get; set; }
        public virtual int HeldCount { get; set; }
        public virtual int ReadyToOffer { get; set; }
        public virtual int? IntakeMin { get; set; }
        public virtual string FacilityNoun { get; set; }
    }

    public partial class CourierProfileOption
    {
        public virtual int CourierProfileID { get; set; }
        public virtual string Name { get; set; }
        public virtual string RouteShape { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual string UnitOne { get; set; }
        public virtual string UnitMany { get; set; }
        public virtual string FacilityNoun { get; set; }
        public virtual List<CourierFacilityOption> Facilities { get; set; } = [];
    }

    public partial class CourierVanChip
    {
        public virtual string Code { get; set; }
        public virtual string CourierStep { get; set; }
        public virtual string LevelCode { get; set; }
        public virtual string LevelName { get; set; }
        public virtual int Units { get; set; }
        public virtual string Area { get; set; }
        public virtual DateTime? DueUtc { get; set; }
        public virtual string DueText { get; set; }
        public virtual bool Movable { get; set; }
        public virtual string NoMoveWhy { get; set; }
        public virtual List<CourierMoveTarget> Targets { get; set; } = [];
    }

    public partial class CourierVansRequest
    {
    }

    public partial class CourierVehicleOption
    {
        public virtual int CourierProfileId { get; set; }
        public virtual int EquipmentID { get; set; }
        public virtual string UnitNumber { get; set; }
        public virtual string VehicleType { get; set; }
        public virtual string CapacityUnit { get; set; }
        public virtual decimal? CapacityLimit { get; set; }
        public virtual bool IsRefrigerated { get; set; }
        public virtual string Status { get; set; }
    }

}

C# 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>