| GET,OPTIONS | /v1/serviceagreement/planner |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| From | query | string | No | |
| Scope | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| FromIso | form | string | No | |
| ToIso | form | string | No | |
| WeekdayCapacity | form | int | No | |
| Rows | form | List<AgreementPlannerRow> | No | |
| Crews | form | List<AgreementPlannerCrew> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgreementID | form | int | No | |
| Name | form | string | No | |
| ProjectName | form | string | No | |
| ServiceType | form | string | No | |
| Area | form | string | No | |
| Zip | form | string | No | |
| Frequency | form | string | No | |
| NextDueIso | form | string | No | |
| NextDueLabel | form | string | No | |
| Overdue | form | bool | No | |
| DurationMin | form | int | No | |
| EligibleDow | form | List<int> | No | |
| ScheduledDow | form | int | No | |
| WeeklyAll | form | bool | No | |
| DueThisWeek | form | bool | No | |
| AssignedCrewID | form | int? | No | |
| AssignedCrewName | form | string | No | |
| ThisWeekJobID | form | int? | No | |
| ThisWeekBackingJobID | form | int? | No | |
| ThisWeekOccIso | form | string | No | |
| ThisWeekStandingIso | form | string | No | |
| StandingDow | form | int? | No | |
| Moved | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CrewID | form | int | No | |
| CrewName | form | string | No | |
| CrewColor | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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"}]}