| GET,OPTIONS | /v1/dispatch/public/pickup/{SchedulerUrl} |
|---|
export class DispatchZoneView
{
public Zone: string;
public Base: number;
public PerBag: number;
public PremiumUpliftPct: number;
public Drivers: number;
public IdleDrivers: number;
public constructor(init?: Partial<DispatchZoneView>) { (Object as any).assign(this, init); }
}
export class DispatchNeedView
{
public Id: string;
public Label: string;
public Sub: string;
public constructor(init?: Partial<DispatchNeedView>) { (Object as any).assign(this, init); }
}
export class DispatchPickupPageResponse
{
public CompanyName: string;
public Zones: DispatchZoneView[] = [];
public Needs: DispatchNeedView[] = [];
public CardEnabled: boolean;
public PublishableKey: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<DispatchPickupPageResponse>) { (Object as any).assign(this, init); }
}
export class DispatchPickupPageRequest
{
public SchedulerUrl: string;
public constructor(init?: Partial<DispatchPickupPageRequest>) { (Object as any).assign(this, init); }
}
TypeScript DispatchPickupPageRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>