Trendsic Platform Service

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 .xml suffix or ?format=xml

HTTP + XML

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

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

<DispatchPickupPageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CardEnabled>false</CardEnabled>
  <CompanyName>String</CompanyName>
  <Needs>
    <DispatchNeedView>
      <Id>String</Id>
      <Label>String</Label>
      <Sub>String</Sub>
    </DispatchNeedView>
  </Needs>
  <PublishableKey>String</PublishableKey>
  <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>
  <Zones>
    <DispatchZoneView>
      <Base>0</Base>
      <Drivers>0</Drivers>
      <IdleDrivers>0</IdleDrivers>
      <PerBag>0</PerBag>
      <PremiumUpliftPct>0</PremiumUpliftPct>
      <Zone>String</Zone>
    </DispatchZoneView>
  </Zones>
</DispatchPickupPageResponse>