Trendsic Platform Service

<back to all web services

VisitExceptionsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/exceptions
"use strict";
export class ExceptionItem {
    /** @param {{Kind?:string,VisitKey?:string,JobID?:number,ProjectID?:number,AgreementID?:number,AgreementJobID?:number,OccurrenceDate?:string,CustomerName?:string,LocationName?:string,City?:string,Lat?:number,Lng?:number,AgeDays?:number,Reason?:string,DurationMinutes?:number,IsCommercial?:boolean,PreferredCrewID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {string} */
    VisitKey;
    /** @type {number} */
    JobID;
    /** @type {number} */
    ProjectID;
    /** @type {?number} */
    AgreementID;
    /** @type {?number} */
    AgreementJobID;
    /** @type {string} */
    OccurrenceDate;
    /** @type {string} */
    CustomerName;
    /** @type {string} */
    LocationName;
    /** @type {string} */
    City;
    /** @type {?number} */
    Lat;
    /** @type {?number} */
    Lng;
    /** @type {number} */
    AgeDays;
    /** @type {string} */
    Reason;
    /** @type {number} */
    DurationMinutes;
    /** @type {boolean} */
    IsCommercial;
    /** @type {?number} */
    PreferredCrewID;
}
export class VisitExceptionsResponse {
    /** @param {{Items?:ExceptionItem[],MissedCount?:number,SlaCount?:number,SkippedCount?:number,AtRiskCount?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ExceptionItem[]} */
    Items = [];
    /** @type {number} */
    MissedCount;
    /** @type {number} */
    SlaCount;
    /** @type {number} */
    SkippedCount;
    /** @type {number} */
    AtRiskCount;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class VisitExceptionsRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript VisitExceptionsRequest 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/visits/exceptions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Items: 
	[
		{
			Kind: String,
			VisitKey: String,
			JobID: 0,
			ProjectID: 0,
			AgreementID: 0,
			AgreementJobID: 0,
			OccurrenceDate: String,
			CustomerName: String,
			LocationName: String,
			City: String,
			Lat: 0,
			Lng: 0,
			AgeDays: 0,
			Reason: String,
			DurationMinutes: 0,
			IsCommercial: False,
			PreferredCrewID: 0
		}
	],
	MissedCount: 0,
	SlaCount: 0,
	SkippedCount: 0,
	AtRiskCount: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}