| GET,OPTIONS | /v1/serviceagreement/{AgreementID}/visits |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgreementID | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Visits | form | List<AgreementVisit> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgreementJobID | form | int | No | |
| AgreementID | form | int | No | |
| JobID | form | int | No | |
| OccurrenceDate | form | DateTime? | No | |
| Status | form | string | No | |
| CompletedAt | form | DateTime? | No | |
| CancelledAt | form | DateTime? | No | |
| CancelReason | form | string | No | |
| ShiftedToDate | form | DateTime? | No | |
| ActualDurationMinutes | form | int? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
Status: String,
CompletedAt: 0001-01-01,
CancelledAt: 0001-01-01,
CancelReason: String,
ShiftedToDate: 0001-01-01,
ActualDurationMinutes: 0
}
]
}