| POST,OPTIONS | /v1/dispatch/courier/recurrences/{Id}/{Action} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No | |
| Action | path | string | No | |
| Date | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Recurrences | form | List<CourierRecurrenceView> | No | |
| Message | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CourierRecurrenceID | form | int | No | |
| CourierProfileId | form | int | No | |
| ProfileName | form | string | No | |
| CourierFacilityId | form | int? | No | |
| CustomerContactId | form | int? | No | |
| CustomerName | form | string | No | |
| CustomerPhone | form | string | No | |
| Address | form | string | No | |
| Unit | form | string | No | |
| City | form | string | No | |
| Zip | form | string | No | |
| Zone | form | string | No | |
| Lat | form | decimal? | No | |
| Lng | form | decimal? | No | |
| Weekday | form | int | No | |
| WindowStart | form | string | No | |
| WindowEnd | form | string | No | |
| Cadence | form | string | No | |
| AnchorDate | form | string | No | |
| ServiceLevelCode | form | string | No | |
| UnitsExpected | form | int | No | |
| Handoff | form | string | No | |
| Instructions | form | string | No | |
| PayMode | form | string | No | |
| AccountCode | form | string | No | |
| Paused | form | bool | No | |
| LastMaterializedDate | form | string | No | |
| NextDate | form | string | No | |
| SkipDates | form | List<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.
POST /v1/dispatch/courier/recurrences/{Id}/{Action} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Action: String,
Date: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Recurrences:
[
{
CourierRecurrenceID: 0,
CourierProfileId: 0,
ProfileName: String,
CourierFacilityId: 0,
CustomerContactId: 0,
CustomerName: String,
CustomerPhone: String,
Address: String,
Unit: String,
City: String,
Zip: String,
Zone: String,
Lat: 0,
Lng: 0,
Weekday: 0,
WindowStart: String,
WindowEnd: String,
Cadence: String,
AnchorDate: String,
ServiceLevelCode: String,
UnitsExpected: 0,
Handoff: String,
Instructions: String,
PayMode: String,
AccountCode: String,
Paused: False,
LastMaterializedDate: String,
NextDate: String,
SkipDates:
[
String
]
}
],
Message: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}