Trendsic Platform Service

<back to all web services

CourierRecurrenceActionRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/recurrences/{Id}/{Action}
CourierRecurrenceActionRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
ActionpathstringNo
DatebodystringNo
CourierRecurrenceResponse Parameters:
NameParameterData TypeRequiredDescription
RecurrencesformList<CourierRecurrenceView>No
MessageformstringNo
ResponseStatusformResponseStatusNo
CourierRecurrenceView Parameters:
NameParameterData TypeRequiredDescription
CourierRecurrenceIDformintNo
CourierProfileIdformintNo
ProfileNameformstringNo
CourierFacilityIdformint?No
CustomerContactIdformint?No
CustomerNameformstringNo
CustomerPhoneformstringNo
AddressformstringNo
UnitformstringNo
CityformstringNo
ZipformstringNo
ZoneformstringNo
Latformdecimal?No
Lngformdecimal?No
WeekdayformintNo
WindowStartformstringNo
WindowEndformstringNo
CadenceformstringNo
AnchorDateformstringNo
ServiceLevelCodeformstringNo
UnitsExpectedformintNo
HandoffformstringNo
InstructionsformstringNo
PayModeformstringNo
AccountCodeformstringNo
PausedformboolNo
LastMaterializedDateformstringNo
NextDateformstringNo
SkipDatesformList<string>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"Action":"String","Date":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}