Trendsic Platform Service

<back to all web services

CourierAvailabilityRequest

Requires Authentication
The following routes are available for this service:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"Availability":{"InArea":false,"ZipChecked":false,"Closed":false,"Windows":[{"Id":"String","DayIx":0,"StartMin":0,"EndMin":0,"Label":"String","Asap":false,"Levels":[{"Code":"String","Name":"String","Ok":false,"Why":"String","Promise":"String","Surcharge":0}]}]},"Date":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}