| GET,OPTIONS | /v1/worker/dispatch/od/stops |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Rows | form | List<CourierStopRow> | No | |
| Hidden | form | bool | No | |
| Facts | form | CourierPingFacts | No | |
| Available | form | bool | No | |
| ServerUtc | form | DateTime | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Kind | form | string | No | |
| AtUtc | form | DateTime | No | |
| OrderCode | form | string | No | |
| Units | form | int | No | |
| OrderCount | form | int? | No | |
| RunCode | form | string | No | |
| StopSeq | form | int? | No | |
| Street | form | string | No | |
| City | form | string | No | |
| Zip | form | string | No | |
| FacilityName | form | string | No | |
| Reason | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Busy | form | bool | No | |
| RadiusMi | form | decimal? | No | |
| HideAddressesInHistory | form | bool | No | |
| PingRadiusMi | form | decimal? | No | |
| PingRadiusUntilUtc | form | DateTime? | No | |
| UnitOne | form | string | No | |
| UnitMany | form | string | No | |
| UnitOneEs | form | string | No | |
| UnitManyEs | form | string | No | |
| FacilityNoun | form | string | No | |
| FacilityNounEs | 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/worker/dispatch/od/stops HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Rows:
[
{
Kind: String,
AtUtc: 0001-01-01,
OrderCode: String,
Units: 0,
OrderCount: 0,
RunCode: String,
StopSeq: 0,
Street: String,
City: String,
Zip: String,
FacilityName: String,
Reason: String
}
],
Hidden: False,
Facts:
{
Busy: False,
RadiusMi: 0,
HideAddressesInHistory: False,
PingRadiusMi: 0,
PingRadiusUntilUtc: 0001-01-01,
UnitOne: String,
UnitMany: String,
UnitOneEs: String,
UnitManyEs: String,
FacilityNoun: String,
FacilityNounEs: String
},
Available: False,
ServerUtc: 0001-01-01,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}