Trendsic Platform Service

<back to all web services

CourierRecurrenceSaveRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/recurrences
PUT,OPTIONS/v1/dispatch/courier/recurrences/{Id}
CourierRecurrenceSaveRequest Parameters:
NameParameterData TypeRequiredDescription
Idpathint?No
RecurrencebodyCourierRecurrenceViewNo
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
CourierRecurrenceResponse Parameters:
NameParameterData TypeRequiredDescription
RecurrencesformList<CourierRecurrenceView>No
MessageformstringNo
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dispatch/courier/recurrences HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Id":0,"Recurrence":{"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"]}}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}