| GET,OPTIONS | /v1/dispatch/courier/vans |
|---|
"use strict";
export class CourierMoveTarget {
/** @param {{DriverContactId?:number,Name?:string,Ok?:boolean,Why?:string,LeaveByText?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DriverContactId;
/** @type {string} */
Name;
/** @type {boolean} */
Ok;
/** @type {string} */
Why;
/** @type {string} */
LeaveByText;
}
export class CourierVanChip {
/** @param {{Code?:string,CourierStep?:string,LevelCode?:string,LevelName?:string,Units?:number,Area?:string,DueUtc?:string,DueText?:string,Movable?:boolean,NoMoveWhy?:string,Targets?:CourierMoveTarget[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {string} */
CourierStep;
/** @type {string} */
LevelCode;
/** @type {string} */
LevelName;
/** @type {number} */
Units;
/** @type {string} */
Area;
/** @type {?string} */
DueUtc;
/** @type {string} */
DueText;
/** @type {boolean} */
Movable;
/** @type {string} */
NoMoveWhy;
/** @type {CourierMoveTarget[]} */
Targets = [];
}
export class CourierOfficeVan {
/** @param {{DriverContactId?:number,DriverCode?:string,Name?:string,Online?:boolean,Zone?:string,VehicleUnit?:string,FacilityName?:string,State?:string,LeaveByUtc?:string,LeaveByText?:string,SlackMin?:number,InVan?:number,Committed?:number,Cap?:number,CapUnit?:string,UnitMany?:string,CriticalCode?:string,DriveMin?:number,SendNote?:string,Aboard?:CourierVanChip[],Queued?:CourierVanChip[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DriverContactId;
/** @type {string} */
DriverCode;
/** @type {string} */
Name;
/** @type {boolean} */
Online;
/** @type {string} */
Zone;
/** @type {string} */
VehicleUnit;
/** @type {string} */
FacilityName;
/** @type {string} */
State;
/** @type {?string} */
LeaveByUtc;
/** @type {string} */
LeaveByText;
/** @type {?number} */
SlackMin;
/** @type {number} */
InVan;
/** @type {number} */
Committed;
/** @type {?number} */
Cap;
/** @type {string} */
CapUnit;
/** @type {string} */
UnitMany;
/** @type {string} */
CriticalCode;
/** @type {number} */
DriveMin;
/** @type {string} */
SendNote;
/** @type {CourierVanChip[]} */
Aboard = [];
/** @type {CourierVanChip[]} */
Queued = [];
}
export class CourierHeldView {
/** @param {{Code?:string,Area?:string,Units?:number,UnitMany?:string,Miles?:number,LevelCode?:string,LevelName?:string,DueText?:string,HeldReason?:string,HeldMin?:number,Why?:string[],BestDriverContactId?:number,BestName?:string,BestLeaveByText?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {string} */
Area;
/** @type {number} */
Units;
/** @type {string} */
UnitMany;
/** @type {?number} */
Miles;
/** @type {string} */
LevelCode;
/** @type {string} */
LevelName;
/** @type {string} */
DueText;
/** @type {string} */
HeldReason;
/** @type {?number} */
HeldMin;
/** @type {string[]} */
Why = [];
/** @type {?number} */
BestDriverContactId;
/** @type {string} */
BestName;
/** @type {string} */
BestLeaveByText;
}
export class CourierVehicleOption {
/** @param {{CourierProfileId?:number,EquipmentID?:number,UnitNumber?:string,VehicleType?:string,CapacityUnit?:string,CapacityLimit?:number,IsRefrigerated?:boolean,Status?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CourierProfileId;
/** @type {number} */
EquipmentID;
/** @type {string} */
UnitNumber;
/** @type {string} */
VehicleType;
/** @type {string} */
CapacityUnit;
/** @type {?number} */
CapacityLimit;
/** @type {boolean} */
IsRefrigerated;
/** @type {string} */
Status;
}
export class CourierFacilityOption {
/** @param {{CourierFacilityID?:number,Code?:string,Name?:string,Address?:string,IntakeMin?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CourierFacilityID;
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {string} */
Address;
/** @type {number} */
IntakeMin;
}
export class CourierProfileOption {
/** @param {{CourierProfileID?:number,Name?:string,RouteShape?:string,Enabled?:boolean,UnitOne?:string,UnitMany?:string,FacilityNoun?:string,Facilities?:CourierFacilityOption[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CourierProfileID;
/** @type {string} */
Name;
/** @type {string} */
RouteShape;
/** @type {boolean} */
Enabled;
/** @type {string} */
UnitOne;
/** @type {string} */
UnitMany;
/** @type {string} */
FacilityNoun;
/** @type {CourierFacilityOption[]} */
Facilities = [];
}
export class CourierDriverOption {
/** @param {{ContactId?:number,Code?:string,Name?:string,Online?:boolean,Zone?:string,VehicleUnit?:string,EquipmentID?:number,SentToFacility?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ContactId;
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {boolean} */
Online;
/** @type {string} */
Zone;
/** @type {string} */
VehicleUnit;
/** @type {?number} */
EquipmentID;
/** @type {boolean} */
SentToFacility;
}
export class CourierDeskRow {
/** @param {{Code?:string,CourierProfileId?:number,FacilityName?:string,LevelCode?:string,LevelName?:string,DueUtc?:string,DueText?:string,Units?:number,UnitsFound?:number,UnitMany?:string,Fare?:number,FinalPrice?:number,TipAmount?:number,PayMode?:string,CaptureMode?:string,CustomerName?:string,Area?:string,IntakeUtc?:string,IntakeMinAgo?:number,DamageNote?:string,FinalPriceAfterCount?:boolean,NeedsPrice?:boolean,ItemCount?:number,MissingCount?:number,PhotoCount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {number} */
CourierProfileId;
/** @type {string} */
FacilityName;
/** @type {string} */
LevelCode;
/** @type {string} */
LevelName;
/** @type {?string} */
DueUtc;
/** @type {string} */
DueText;
/** @type {number} */
Units;
/** @type {?number} */
UnitsFound;
/** @type {string} */
UnitMany;
/** @type {?number} */
Fare;
/** @type {?number} */
FinalPrice;
/** @type {?number} */
TipAmount;
/** @type {string} */
PayMode;
/** @type {string} */
CaptureMode;
/** @type {string} */
CustomerName;
/** @type {string} */
Area;
/** @type {?string} */
IntakeUtc;
/** @type {?number} */
IntakeMinAgo;
/** @type {string} */
DamageNote;
/** @type {boolean} */
FinalPriceAfterCount;
/** @type {boolean} */
NeedsPrice;
/** @type {number} */
ItemCount;
/** @type {number} */
MissingCount;
/** @type {number} */
PhotoCount;
}
export class CourierOfficeView {
/** @param {{ServerUtc?:string,Vans?:CourierOfficeVan[],Held?:CourierHeldView[],Vehicles?:CourierVehicleOption[],Profiles?:CourierProfileOption[],Drivers?:CourierDriverOption[],Desk?:CourierDeskRow[],GoCount?:number,HeldCount?:number,ReadyToOffer?:number,IntakeMin?:number,FacilityNoun?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ServerUtc;
/** @type {CourierOfficeVan[]} */
Vans = [];
/** @type {CourierHeldView[]} */
Held = [];
/** @type {CourierVehicleOption[]} */
Vehicles = [];
/** @type {CourierProfileOption[]} */
Profiles = [];
/** @type {CourierDriverOption[]} */
Drivers = [];
/** @type {CourierDeskRow[]} */
Desk = [];
/** @type {number} */
GoCount;
/** @type {number} */
HeldCount;
/** @type {number} */
ReadyToOffer;
/** @type {?number} */
IntakeMin;
/** @type {string} */
FacilityNoun;
}
export class CourierOfficeResponse {
/** @param {{Office?:CourierOfficeView,Available?:boolean,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CourierOfficeView} */
Office;
/** @type {boolean} */
Available;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class CourierVansRequest {
constructor(init) { Object.assign(this, init) }
}
JavaScript CourierVansRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>