| GET,OPTIONS | /v1/dispatch/public/pickup/{SchedulerUrl} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SchedulerUrl | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyName | form | string | No | |
| Zones | form | List<DispatchZoneView> | No | |
| Needs | form | List<DispatchNeedView> | No | |
| CardEnabled | form | bool | No | |
| PublishableKey | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Zone | form | string | No | |
| Base | form | decimal | No | |
| PerBag | form | decimal | No | |
| PremiumUpliftPct | form | decimal | No | |
| Drivers | form | int | No | |
| IdleDrivers | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Label | form | string | No | |
| Sub | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}