Trendsic Platform Service

<back to all web services

RoutePlanWeekRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/routeplan/week
RoutePlanWeekRequest Parameters:
NameParameterData TypeRequiredDescription
FromquerystringNo
RoutePlanWeekResponse Parameters:
NameParameterData TypeRequiredDescription
FromIsoformstringNo
ToIsoformstringNo
CrewsformList<RoutePlanCrew>No
VisitsformList<RoutePlanVisit>No
SkippedformList<RoutePlanSkippedVisit>No
ResponseStatusformResponseStatusNo
RoutePlanCrew Parameters:
NameParameterData TypeRequiredDescription
CrewIDformintNo
CrewNameformstringNo
CrewColorformstringNo
HomeZipformstringNo
YardLatformdouble?No
YardLngformdouble?No
DailyCapacityMinformintNo
WeeklyCapacityMinformintNo
SpecialistformboolNo
RoutePlanVisit Parameters:
NameParameterData TypeRequiredDescription
AgreementIDformintNo
AgreementJobIDformint?No
NameformstringNo
SubformstringNo
ServiceTypeformstringNo
ZipformstringNo
AreaformstringNo
Latformdouble?No
Lngformdouble?No
DurationMinformintNo
DueIsoformstringNo
DueLabelformstringNo
OverdueformboolNo
DefaultCrewIDformint?No
RouteCrewIDformint?No
RouteSeqformint?No
RouteDateIsoformstringNo
LateDaysformintNo
AutoPayformboolNo
SkipPolicyformstringNo
SkipCreditAmountformdecimalNo
RoutePlanSkippedVisit Parameters:
NameParameterData TypeRequiredDescription
AgreementJobIDformintNo
AgreementIDformintNo
NameformstringNo
DateIsoformstringNo
ReasonformstringNo
CreditAmountformdecimalNo

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

HTTP + OTHER

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

GET /v1/routeplan/week HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"FromIso":"String","ToIso":"String","Crews":[{"CrewID":0,"CrewName":"String","CrewColor":"String","HomeZip":"String","YardLat":0,"YardLng":0,"DailyCapacityMin":0,"WeeklyCapacityMin":0,"Specialist":false}],"Visits":[{"AgreementID":0,"AgreementJobID":0,"Name":"String","Sub":"String","ServiceType":"String","Zip":"String","Area":"String","Lat":0,"Lng":0,"DurationMin":0,"DueIso":"String","DueLabel":"String","Overdue":false,"DefaultCrewID":0,"RouteCrewID":0,"RouteSeq":0,"RouteDateIso":"String","LateDays":0,"AutoPay":false,"SkipPolicy":"String","SkipCreditAmount":0}],"Skipped":[{"AgreementJobID":0,"AgreementID":0,"Name":"String","DateIso":"String","Reason":"String","CreditAmount":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}