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
"use strict";
export class AgreementVisit {
    /** @param {{AgreementJobID?:number,AgreementID?:number,JobID?:number,OccurrenceDate?:string,Status?:string,CompletedAt?:string,CancelledAt?:string,CancelReason?:string,ShiftedToDate?:string,ActualDurationMinutes?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementJobID;
    /** @type {number} */
    AgreementID;
    /** @type {number} */
    JobID;
    /** @type {?string} */
    OccurrenceDate;
    /** @type {string} */
    Status;
    /** @type {?string} */
    CompletedAt;
    /** @type {?string} */
    CancelledAt;
    /** @type {string} */
    CancelReason;
    /** @type {?string} */
    ShiftedToDate;
    /** @type {?number} */
    ActualDurationMinutes;
}
export class AgreementVisitsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Visits?:AgreementVisit[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgreementVisit[]} */
    Visits = [];
}
export class AgreementVisitsRequest {
    /** @param {{AgreementID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementID;
}

JavaScript AgreementVisitsRequest DTOs

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

HTTP + 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
		}
	]
}