| GET,OPTIONS | /v1/visits/board |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Date | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Date | form | string | No | |
| Crews | form | List<CrewColumn> | No | |
| Unassigned | form | List<VisitCard> | No | |
| Readiness | form | BoardReadiness | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CrewID | form | int | No | |
| CrewName | form | string | No | |
| CrewColor | form | string | No | |
| MemberCount | form | int | No | |
| Visits | form | List<VisitCard> | No | |
| DriveMiles | form | double | No | |
| DriveMinutes | form | int | No | |
| OnSiteMinutes | form | int | No | |
| BillablePct | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| VisitKey | form | string | No | |
| JobID | form | int | No | |
| ProjectID | form | int | No | |
| ProjectUID | form | string | No | |
| AgreementJobID | form | int? | No | |
| ScheduledDate | form | string | No | |
| CustomerName | form | string | No | |
| JobName | form | string | No | |
| LocationName | form | string | No | |
| City | form | string | No | |
| Zip | form | string | No | |
| Lat | form | double? | No | |
| Lng | form | double? | No | |
| CrewID | form | int? | No | |
| CrewName | form | string | No | |
| SortOrder | form | int | No | |
| Status | form | string | No | |
| DurationMinutes | form | int | No | |
| EtaWindow | form | string | No | |
| IsCommercial | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalVisits | form | int | No | |
| Assigned | form | int | No | |
| Unassigned | form | int | No | |
| Conflicts | form | int | No | |
| AssignedPct | form | int | 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/visits/board HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Date":"String","Crews":[{"CrewID":0,"CrewName":"String","CrewColor":"String","MemberCount":0,"Visits":[{"VisitKey":"String","JobID":0,"ProjectID":0,"ProjectUID":"String","AgreementJobID":0,"ScheduledDate":"String","CustomerName":"String","JobName":"String","LocationName":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CrewID":0,"CrewName":"String","SortOrder":0,"Status":"String","DurationMinutes":0,"EtaWindow":"String","IsCommercial":false}],"DriveMiles":0,"DriveMinutes":0,"OnSiteMinutes":0,"BillablePct":0}],"Unassigned":[{"VisitKey":"String","JobID":0,"ProjectID":0,"ProjectUID":"String","AgreementJobID":0,"ScheduledDate":"String","CustomerName":"String","JobName":"String","LocationName":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CrewID":0,"CrewName":"String","SortOrder":0,"Status":"String","DurationMinutes":0,"EtaWindow":"String","IsCommercial":false}],"Readiness":{"TotalVisits":0,"Assigned":0,"Unassigned":0,"Conflicts":0,"AssignedPct":0},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}