Trendsic Platform Service

<back to all web services

CourierNewVehicleRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/profiles/{Id}/vehicle

export class CourierProfileSummary
{
    public CourierProfileID: number;
    public Code: string;
    public Name: string;
    public BusinessName: string;
    public RouteShape: string;
    public Enabled: boolean;
    public TemplateFrom: string;
    public Drivers: number;

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

export class CourierTemplateOption
{
    public Key: string;
    public Label: string;
    public Detail: string;
    public RouteShape: string;

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

export class CourierPay
{
    public WorkerClass: string;
    public PerPickup: number;
    public PerStop: number;
    public PerMissed: number;
    public PerCancel: number;
    public WaitAfterMin: number;
    public WaitPerMin: number;
    public MileageOn: boolean;
    public PerMile: number;
    public MinPerJob: number;
    public TipsPct: number;

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

export class CourierDispatch
{
    public PingSecs: number;
    public RadiusMi: number;
    public DeclinePenalty: boolean;
    public NextRule: string;
    public GoMin: number;
    public LastMin: number;
    public NearFull: number;
    public MarginMin: number;
    public TrafficSource: string;

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

export class CourierMissed
{
    public WaitMin: number;
    public Fee: number;
    public CancelFee: number;
    public AutoRebook: boolean;
    public RequireContact: boolean;
    public RequirePhoto: boolean;

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

export class CourierPrivacy
{
    public ThreadHrs: number;
    public PhotoDays: number;
    public LockNames: string;
    public HideAddr: boolean;
    public LiveEta: boolean;
    public Tipping: boolean;

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

export class CourierPricing
{
    public Base: number;
    public PerUnit: number;
    public PerMile: number;
    public MinOrder: number;
    public TaxPct: number;
    public FinalAfterCount: boolean;
    public ServiceArea: string[] = [];
    public WindowMin: number;
    public Surcharges: { [index:string]: number; } = {};

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

export class CourierBooking
{
    public On: boolean;
    public Slug: string;
    public Asap: boolean;
    public MinLeadMin: number;
    public Open: string;
    public Close: string;
    public DriveBufferMin: number;
    public Zips: string[] = [];
    public Recurring: boolean;
    public PayTiming: string;

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

export class CourierLevelView
{
    public Code: string;
    public Name: string;
    public InBy: string;
    public WithinMin: number;
    public Ready: string;
    public Days: number[] = [];
    public IsOn: boolean;

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

export class CourierFacilityView
{
    public Code: string;
    public Name: string;
    public Address: string;
    public IntakeMin: number;
    public Levels: CourierLevelView[] = [];
    public Holidays: string[] = [];

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

export class CourierVehicleView
{
    public EquipmentID: number;
    public UnitNumber: string;
    public Name: string;
    public Unit: string;
    public Cap: number;
    public Cold: boolean;

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

export class CourierProfileContext
{
    public Drivers: number;
    public ProfileCount: number;
    public PayPlanId?: number;
    public ZoneMode: string;
    public ZoneName: string;
    public ZoneCount: number;
    public HasBookingPage: boolean;
    public HasRateConfig: boolean;
    public VehicleFacts: { [index:string]: string; } = {};

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

export class CourierProfileView
{
    public CourierProfileID: number;
    public Code: string;
    public Name: string;
    public BusinessName: string;
    public RouteShape: string;
    public Enabled: boolean;
    public TemplateFrom: string;
    public UnitOne: string;
    public UnitMany: string;
    public FacilityNoun: string;
    public UnitOneEs: string;
    public UnitManyEs: string;
    public FacilityNounEs: string;
    public TagMode: string;
    public TagFormats: string[] = [];
    public Pay: CourierPay;
    public Dispatch: CourierDispatch;
    public Missed: CourierMissed;
    public Privacy: CourierPrivacy;
    public Pricing: CourierPricing;
    public Booking: CourierBooking;
    public Facilities: CourierFacilityView[] = [];
    public Vehicles: CourierVehicleView[] = [];
    public Proof: { [index:string]: { [index:string]: string; }; } = {};
    public Context: CourierProfileContext;

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

export class CourierIssue
{
    public Key: string;
    public Section: string;
    public Message: string;

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

export class CourierChange
{
    public Key: string;
    public Section: string;
    public Label: string;
    public From: string;
    public To: string;

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

export class CourierPreviewLine
{
    public K: string;
    public V: string;
    public Dot: string;

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

export class CourierPreview
{
    public DeadlineTitle: string;
    public DeadlineLead: string;
    public RoomW: string;
    public LastW: string;
    public GoW: string;
    public Zones: CourierPreviewLine[] = [];
    public PaySub: string;
    public PayRows: CourierPreviewLine[] = [];
    public PayTotal: string;
    public ProofRows: CourierPreviewLine[] = [];
    public Ping: string;

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

export class CourierFleetVehicle
{
    public EquipmentID: number;
    public UnitNumber: string;
    public Name: string;
    public VehicleType: string;
    public Unit: string;
    public Cap?: number;
    public Cold: boolean;
    public Status: string;
    public Assigned: boolean;

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

export class CourierResponse
{
    public Profiles: CourierProfileSummary[] = [];
    public Templates: CourierTemplateOption[] = [];
    public Profile: CourierProfileView;
    public Issues: CourierIssue[] = [];
    public Changes: CourierChange[] = [];
    public Preview: CourierPreview;
    public Fleet: CourierFleetVehicle[] = [];
    public ResponseStatus: ResponseStatus;

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

export class CourierNewVehicleRequest
{
    public Id: number;
    public UnitNumber: string;
    public Name: string;
    public VehicleType: string;
    public Unit: string;
    public Cap: number;
    public Cold: boolean;

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

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

POST /v1/dispatch/courier/profiles/{Id}/vehicle HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourierNewVehicleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Cap>0</Cap>
  <Cold>false</Cold>
  <Id>0</Id>
  <Name>String</Name>
  <Unit>String</Unit>
  <UnitNumber>String</UnitNumber>
  <VehicleType>String</VehicleType>
</CourierNewVehicleRequest>

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

<CourierResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Changes>
    <CourierChange>
      <From>String</From>
      <Key>String</Key>
      <Label>String</Label>
      <Section>String</Section>
      <To>String</To>
    </CourierChange>
  </Changes>
  <Fleet>
    <CourierFleetVehicle>
      <Assigned>false</Assigned>
      <Cap>0</Cap>
      <Cold>false</Cold>
      <EquipmentID>0</EquipmentID>
      <Name>String</Name>
      <Status>String</Status>
      <Unit>String</Unit>
      <UnitNumber>String</UnitNumber>
      <VehicleType>String</VehicleType>
    </CourierFleetVehicle>
  </Fleet>
  <Issues>
    <CourierIssue>
      <Key>String</Key>
      <Message>String</Message>
      <Section>String</Section>
    </CourierIssue>
  </Issues>
  <Preview>
    <DeadlineLead>String</DeadlineLead>
    <DeadlineTitle>String</DeadlineTitle>
    <GoW>String</GoW>
    <LastW>String</LastW>
    <PayRows>
      <CourierPreviewLine>
        <Dot>String</Dot>
        <K>String</K>
        <V>String</V>
      </CourierPreviewLine>
    </PayRows>
    <PaySub>String</PaySub>
    <PayTotal>String</PayTotal>
    <Ping>String</Ping>
    <ProofRows>
      <CourierPreviewLine>
        <Dot>String</Dot>
        <K>String</K>
        <V>String</V>
      </CourierPreviewLine>
    </ProofRows>
    <RoomW>String</RoomW>
    <Zones>
      <CourierPreviewLine>
        <Dot>String</Dot>
        <K>String</K>
        <V>String</V>
      </CourierPreviewLine>
    </Zones>
  </Preview>
  <Profile>
    <Booking>
      <Asap>false</Asap>
      <Close>String</Close>
      <DriveBufferMin>0</DriveBufferMin>
      <MinLeadMin>0</MinLeadMin>
      <On>false</On>
      <Open>String</Open>
      <PayTiming>String</PayTiming>
      <Recurring>false</Recurring>
      <Slug>String</Slug>
      <Zips xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Zips>
    </Booking>
    <BusinessName>String</BusinessName>
    <Code>String</Code>
    <Context>
      <Drivers>0</Drivers>
      <HasBookingPage>false</HasBookingPage>
      <HasRateConfig>false</HasRateConfig>
      <PayPlanId>0</PayPlanId>
      <ProfileCount>0</ProfileCount>
      <VehicleFacts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </VehicleFacts>
      <ZoneCount>0</ZoneCount>
      <ZoneMode>String</ZoneMode>
      <ZoneName>String</ZoneName>
    </Context>
    <CourierProfileID>0</CourierProfileID>
    <Dispatch>
      <DeclinePenalty>false</DeclinePenalty>
      <GoMin>0</GoMin>
      <LastMin>0</LastMin>
      <MarginMin>0</MarginMin>
      <NearFull>0</NearFull>
      <NextRule>String</NextRule>
      <PingSecs>0</PingSecs>
      <RadiusMi>0</RadiusMi>
      <TrafficSource>String</TrafficSource>
    </Dispatch>
    <Enabled>false</Enabled>
    <Facilities>
      <CourierFacilityView>
        <Address>String</Address>
        <Code>String</Code>
        <Holidays xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Holidays>
        <IntakeMin>0</IntakeMin>
        <Levels>
          <CourierLevelView>
            <Code>String</Code>
            <Days xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </Days>
            <InBy>String</InBy>
            <IsOn>false</IsOn>
            <Name>String</Name>
            <Ready>String</Ready>
            <WithinMin>0</WithinMin>
          </CourierLevelView>
        </Levels>
        <Name>String</Name>
      </CourierFacilityView>
    </Facilities>
    <FacilityNoun>String</FacilityNoun>
    <FacilityNounEs>String</FacilityNounEs>
    <Missed>
      <AutoRebook>false</AutoRebook>
      <CancelFee>0</CancelFee>
      <Fee>0</Fee>
      <RequireContact>false</RequireContact>
      <RequirePhoto>false</RequirePhoto>
      <WaitMin>0</WaitMin>
    </Missed>
    <Name>String</Name>
    <Pay>
      <MileageOn>false</MileageOn>
      <MinPerJob>0</MinPerJob>
      <PerCancel>0</PerCancel>
      <PerMile>0</PerMile>
      <PerMissed>0</PerMissed>
      <PerPickup>0</PerPickup>
      <PerStop>0</PerStop>
      <TipsPct>0</TipsPct>
      <WaitAfterMin>0</WaitAfterMin>
      <WaitPerMin>0</WaitPerMin>
      <WorkerClass>String</WorkerClass>
    </Pay>
    <Pricing>
      <Base>0</Base>
      <FinalAfterCount>false</FinalAfterCount>
      <MinOrder>0</MinOrder>
      <PerMile>0</PerMile>
      <PerUnit>0</PerUnit>
      <ServiceArea xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </ServiceArea>
      <Surcharges xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringdecimal>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:KeyValueOfstringdecimal>
      </Surcharges>
      <TaxPct>0</TaxPct>
      <WindowMin>0</WindowMin>
    </Pricing>
    <Privacy>
      <HideAddr>false</HideAddr>
      <LiveEta>false</LiveEta>
      <LockNames>String</LockNames>
      <PhotoDays>0</PhotoDays>
      <ThreadHrs>0</ThreadHrs>
      <Tipping>false</Tipping>
    </Privacy>
    <Proof xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>
          <d3p1:KeyValueOfstringstring>
            <d3p1:Key>String</d3p1:Key>
            <d3p1:Value>String</d3p1:Value>
          </d3p1:KeyValueOfstringstring>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1>
    </Proof>
    <RouteShape>String</RouteShape>
    <TagFormats xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </TagFormats>
    <TagMode>String</TagMode>
    <TemplateFrom>String</TemplateFrom>
    <UnitMany>String</UnitMany>
    <UnitManyEs>String</UnitManyEs>
    <UnitOne>String</UnitOne>
    <UnitOneEs>String</UnitOneEs>
    <Vehicles>
      <CourierVehicleView>
        <Cap>0</Cap>
        <Cold>false</Cold>
        <EquipmentID>0</EquipmentID>
        <Name>String</Name>
        <Unit>String</Unit>
        <UnitNumber>String</UnitNumber>
      </CourierVehicleView>
    </Vehicles>
  </Profile>
  <Profiles>
    <CourierProfileSummary>
      <BusinessName>String</BusinessName>
      <Code>String</Code>
      <CourierProfileID>0</CourierProfileID>
      <Drivers>0</Drivers>
      <Enabled>false</Enabled>
      <Name>String</Name>
      <RouteShape>String</RouteShape>
      <TemplateFrom>String</TemplateFrom>
    </CourierProfileSummary>
  </Profiles>
  <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>
  <Templates>
    <CourierTemplateOption>
      <Detail>String</Detail>
      <Key>String</Key>
      <Label>String</Label>
      <RouteShape>String</RouteShape>
    </CourierTemplateOption>
  </Templates>
</CourierResponse>