| GET,OPTIONS | /v1/dispatch/courier/profiles/{Id}/availability |
|---|
"use strict";
export class LevelOffer {
/** @param {{Code?:string,Name?:string,Ok?:boolean,Why?:string,Promise?:string,Surcharge?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {boolean} */
Ok;
/** @type {string} */
Why;
/** @type {string} */
Promise;
/** @type {number} */
Surcharge;
}
export class Window {
/** @param {{Id?:string,DayIx?:number,StartMin?:number,EndMin?:number,Label?:string,Asap?:boolean,Levels?:LevelOffer[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {number} */
DayIx;
/** @type {number} */
StartMin;
/** @type {number} */
EndMin;
/** @type {string} */
Label;
/** @type {boolean} */
Asap;
/** @type {LevelOffer[]} */
Levels = [];
}
export class Availability {
/** @param {{InArea?:boolean,ZipChecked?:boolean,Closed?:boolean,Windows?:Window[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
InArea;
/** @type {boolean} */
ZipChecked;
/** @type {boolean} */
Closed;
/** @type {Window[]} */
Windows = [];
}
export class CourierAvailabilityResponse {
/** @param {{Availability?:Availability,Date?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Availability} */
Availability;
/** @type {string} */
Date;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class CourierAvailabilityRequest {
/** @param {{Id?:number,Date?:string,Zip?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Date;
/** @type {string} */
Zip;
}
JavaScript CourierAvailabilityRequest 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/profiles/{Id}/availability HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CourierAvailabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Availability>
<Closed>false</Closed>
<InArea>false</InArea>
<Windows>
<CourierEngine.Window>
<Asap>false</Asap>
<DayIx>0</DayIx>
<EndMin>0</EndMin>
<Id>String</Id>
<Label>String</Label>
<Levels>
<CourierEngine.LevelOffer>
<Code>String</Code>
<Name>String</Name>
<Ok>false</Ok>
<Promise>String</Promise>
<Surcharge>0</Surcharge>
<Why>String</Why>
</CourierEngine.LevelOffer>
</Levels>
<StartMin>0</StartMin>
</CourierEngine.Window>
</Windows>
<ZipChecked>false</ZipChecked>
</Availability>
<Date>String</Date>
<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>
</CourierAvailabilityResponse>