Trendsic Platform Service

<back to all web services

CourierDriverVehicleRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/worker/dispatch/od/vehicle
"use strict";
export class CourierVehicleClassView {
    /** @param {{Code?:string,Name?:string,NameEs?:string,Hint?:string,HintEs?:string,Cap?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    NameEs;
    /** @type {string} */
    Hint;
    /** @type {string} */
    HintEs;
    /** @type {number} */
    Cap;
}
export class CourierDriverVehicleResponse {
    /** @param {{EquipmentID?:number,UnitNumber?:string,IsOwn?:boolean,SetByOffice?:boolean,ClassCode?:string,ClassName?:string,ClassNameEs?:string,Cap?:number,UnitOne?:string,UnitMany?:string,UnitOneEs?:string,UnitManyEs?:string,Classes?:CourierVehicleClassView[],Saved?:boolean,SavedText?:string,SavedTextEs?:string,MessageEs?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    EquipmentID;
    /** @type {string} */
    UnitNumber;
    /** @type {boolean} */
    IsOwn;
    /** @type {boolean} */
    SetByOffice;
    /** @type {string} */
    ClassCode;
    /** @type {string} */
    ClassName;
    /** @type {string} */
    ClassNameEs;
    /** @type {?number} */
    Cap;
    /** @type {string} */
    UnitOne;
    /** @type {string} */
    UnitMany;
    /** @type {string} */
    UnitOneEs;
    /** @type {string} */
    UnitManyEs;
    /** @type {CourierVehicleClassView[]} */
    Classes = [];
    /** @type {boolean} */
    Saved;
    /** @type {string} */
    SavedText;
    /** @type {string} */
    SavedTextEs;
    /** @type {string} */
    MessageEs;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CourierDriverVehicleRequest {
    /** @param {{ClassCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ClassCode;
}

JavaScript CourierDriverVehicleRequest 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.

PUT /v1/worker/dispatch/od/vehicle HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourierDriverVehicleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ClassCode>String</ClassCode>
</CourierDriverVehicleRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierDriverVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Cap>0</Cap>
  <ClassCode>String</ClassCode>
  <ClassName>String</ClassName>
  <ClassNameEs>String</ClassNameEs>
  <Classes>
    <CourierVehicleClassView>
      <Cap>0</Cap>
      <Code>String</Code>
      <Hint>String</Hint>
      <HintEs>String</HintEs>
      <Name>String</Name>
      <NameEs>String</NameEs>
    </CourierVehicleClassView>
  </Classes>
  <EquipmentID>0</EquipmentID>
  <IsOwn>false</IsOwn>
  <MessageEs>String</MessageEs>
  <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>
  <Saved>false</Saved>
  <SavedText>String</SavedText>
  <SavedTextEs>String</SavedTextEs>
  <SetByOffice>false</SetByOffice>
  <UnitMany>String</UnitMany>
  <UnitManyEs>String</UnitManyEs>
  <UnitNumber>String</UnitNumber>
  <UnitOne>String</UnitOne>
  <UnitOneEs>String</UnitOneEs>
</CourierDriverVehicleResponse>