Trendsic Platform Service

<back to all web services

DispatchPickupPageRequest

The following routes are available for this service:
GET,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}
"use strict";
export class DispatchZoneView {
    /** @param {{Zone?:string,Base?:number,PerBag?:number,PremiumUpliftPct?:number,Drivers?:number,IdleDrivers?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Zone;
    /** @type {number} */
    Base;
    /** @type {number} */
    PerBag;
    /** @type {number} */
    PremiumUpliftPct;
    /** @type {number} */
    Drivers;
    /** @type {number} */
    IdleDrivers;
}
export class DispatchNeedView {
    /** @param {{Id?:string,Label?:string,Sub?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Label;
    /** @type {string} */
    Sub;
}
export class DispatchPickupPageResponse {
    /** @param {{CompanyName?:string,Zones?:DispatchZoneView[],Needs?:DispatchNeedView[],CardEnabled?:boolean,PublishableKey?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyName;
    /** @type {DispatchZoneView[]} */
    Zones = [];
    /** @type {DispatchNeedView[]} */
    Needs = [];
    /** @type {boolean} */
    CardEnabled;
    /** @type {string} */
    PublishableKey;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchPickupPageRequest {
    /** @param {{SchedulerUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SchedulerUrl;
}

JavaScript DispatchPickupPageRequest 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/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"CompanyName":"String","Zones":[{"Zone":"String","Base":0,"PerBag":0,"PremiumUpliftPct":0,"Drivers":0,"IdleDrivers":0}],"Needs":[{"Id":"String","Label":"String","Sub":"String"}],"CardEnabled":false,"PublishableKey":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}