Trendsic Platform Service

<back to all web services

AgreementVisitsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/{AgreementID}/visits
AgreementVisitsRequest Parameters:
NameParameterData TypeRequiredDescription
AgreementIDpathintNo
AgreementVisitsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
VisitsformList<AgreementVisit>No
AgreementVisit Parameters:
NameParameterData TypeRequiredDescription
AgreementJobIDformintNo
AgreementIDformintNo
JobIDformintNo
OccurrenceDateformDateTime?No
StatusformstringNo
CompletedAtformDateTime?No
CancelledAtformDateTime?No
CancelReasonformstringNo
ShiftedToDateformDateTime?No
ActualDurationMinutesformint?No

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

HTTP + CSV

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

GET /v1/serviceagreement/{AgreementID}/visits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Visits":[{"AgreementJobID":0,"AgreementID":0,"JobID":0,"OccurrenceDate":"0001-01-01T00:00:00.0000000","Status":"String","CompletedAt":"0001-01-01T00:00:00.0000000","CancelledAt":"0001-01-01T00:00:00.0000000","CancelReason":"String","ShiftedToDate":"0001-01-01T00:00:00.0000000","ActualDurationMinutes":0}]}