Trendsic Platform Service

<back to all web services

DispatchTrackRequest

The following routes are available for this service:
GET,OPTIONS/v1/dispatch/track/{Token}/json
"use strict";
export class DispatchTrackStepView {
    /** @param {{Name?:string,At?:string,Done?:boolean,Current?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {?string} */
    At;
    /** @type {boolean} */
    Done;
    /** @type {boolean} */
    Current;
}
export class DispatchTrackResponse {
    /** @param {{Kind?:string,Code?:string,What?:string,FromLoc?:string,ToLoc?:string,Bags?:number,Fare?:number,PayMode?:string,CardLast4?:string,Charged?:boolean,Stage?:string,Headline?:string,Sub?:string,IsClosed?:boolean,Eta?:string,DriverName?:string,CustomerName?:string,Steps?:DispatchTrackStepView[],Expired?:boolean,Invalid?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {string} */
    Code;
    /** @type {string} */
    What;
    /** @type {string} */
    FromLoc;
    /** @type {string} */
    ToLoc;
    /** @type {?number} */
    Bags;
    /** @type {?number} */
    Fare;
    /** @type {string} */
    PayMode;
    /** @type {string} */
    CardLast4;
    /** @type {boolean} */
    Charged;
    /** @type {string} */
    Stage;
    /** @type {string} */
    Headline;
    /** @type {string} */
    Sub;
    /** @type {boolean} */
    IsClosed;
    /** @type {string} */
    Eta;
    /** @type {string} */
    DriverName;
    /** @type {string} */
    CustomerName;
    /** @type {DispatchTrackStepView[]} */
    Steps = [];
    /** @type {boolean} */
    Expired;
    /** @type {boolean} */
    Invalid;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchTrackRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

JavaScript DispatchTrackRequest 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/track/{Token}/json HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"Kind":"String","Code":"String","What":"String","FromLoc":"String","ToLoc":"String","Bags":0,"Fare":0,"PayMode":"String","CardLast4":"String","Charged":false,"Stage":"String","Headline":"String","Sub":"String","IsClosed":false,"Eta":"String","DriverName":"String","CustomerName":"String","Steps":[{"Name":"String","At":"0001-01-01T00:00:00.0000000","Done":false,"Current":false}],"Expired":false,"Invalid":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}