Trendsic Platform Service

<back to all web services

AgreementVisitCancelRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/serviceagreement/visit/{AgreementJobID}/cancel
AgreementVisitCancelRequest Parameters:
NameParameterData TypeRequiredDescription
AgreementJobIDpathintNo
ReasonbodystringNo
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 .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.

POST /v1/serviceagreement/visit/{AgreementJobID}/cancel HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AgreementJobID":0,"Reason":"String"}
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"}},"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}]}