Trendsic Platform Service

<back to all web services

AgreementPlannerRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/planner
AgreementPlannerRequest Parameters:
NameParameterData TypeRequiredDescription
FromquerystringNo
ScopequerystringNo
AgreementPlannerResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
FromIsoformstringNo
ToIsoformstringNo
WeekdayCapacityformintNo
RowsformList<AgreementPlannerRow>No
CrewsformList<AgreementPlannerCrew>No
AgreementPlannerRow Parameters:
NameParameterData TypeRequiredDescription
AgreementIDformintNo
NameformstringNo
ProjectNameformstringNo
ServiceTypeformstringNo
AreaformstringNo
ZipformstringNo
FrequencyformstringNo
NextDueIsoformstringNo
NextDueLabelformstringNo
OverdueformboolNo
DurationMinformintNo
EligibleDowformList<int>No
ScheduledDowformintNo
WeeklyAllformboolNo
DueThisWeekformboolNo
AssignedCrewIDformint?No
AssignedCrewNameformstringNo
ThisWeekJobIDformint?No
ThisWeekBackingJobIDformint?No
ThisWeekOccIsoformstringNo
ThisWeekStandingIsoformstringNo
StandingDowformint?No
MovedformboolNo
AgreementPlannerCrew Parameters:
NameParameterData TypeRequiredDescription
CrewIDformintNo
CrewNameformstringNo
CrewColorformstringNo

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/serviceagreement/planner HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"FromIso":"String","ToIso":"String","WeekdayCapacity":0,"Rows":[{"AgreementID":0,"Name":"String","ProjectName":"String","ServiceType":"String","Area":"String","Zip":"String","Frequency":"String","NextDueIso":"String","NextDueLabel":"String","Overdue":false,"DurationMin":0,"EligibleDow":[0],"ScheduledDow":0,"WeeklyAll":false,"DueThisWeek":false,"AssignedCrewID":0,"AssignedCrewName":"String","ThisWeekJobID":0,"ThisWeekBackingJobID":0,"ThisWeekOccIso":"String","ThisWeekStandingIso":"String","StandingDow":0,"Moved":false}],"Crews":[{"CrewID":0,"CrewName":"String","CrewColor":"String"}]}