Trendsic Platform Service

<back to all web services

DispatchPickupPageRequest

The following routes are available for this service:
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}