Trendsic Platform Service

<back to all web services

DispatchPickupBookRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}

export class DispatchPickupBookResponse
{
    public Code: string;
    public Fare: number;
    public Zone: string;
    public Bags: number;
    public PayMode: string;
    public PayLine: string;
    public TrackUrl: string;
    public BookToken: string;
    public ClientSecret: string;
    public PublishableKey: string;
    public Delivery: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchPickupBookResponse>) { (Object as any).assign(this, init); }
}

export class DispatchPickupBookRequest
{
    public SchedulerUrl: string;
    public Address: string;
    public Unit: string;
    public City: string;
    public Zip: string;
    public Zone: string;
    public Bags: number;
    public Needs: string[] = [];
    public Note: string;
    public CustomerName: string;
    public CustomerPhone: string;
    public PayMode: string;
    public AccountCode: string;
    public TurnstileToken: string;

    public constructor(init?: Partial<DispatchPickupBookRequest>) { (Object as any).assign(this, init); }
}

TypeScript DispatchPickupBookRequest 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.

POST /v1/dispatch/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SchedulerUrl":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Zone":"String","Bags":0,"Needs":["String"],"Note":"String","CustomerName":"String","CustomerPhone":"String","PayMode":"String","AccountCode":"String","TurnstileToken":"String"}

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

{"Code":"String","Fare":0,"Zone":"String","Bags":0,"PayMode":"String","PayLine":"String","TrackUrl":"String","BookToken":"String","ClientSecret":"String","PublishableKey":"String","Delivery":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}