Trendsic Platform Service

<back to all web services

VisitExceptionsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/exceptions

export class ExceptionItem
{
    public Kind: string;
    public VisitKey: string;
    public JobID: number;
    public ProjectID: number;
    public AgreementID?: number;
    public AgreementJobID?: number;
    public OccurrenceDate: string;
    public CustomerName: string;
    public LocationName: string;
    public City: string;
    public Lat?: number;
    public Lng?: number;
    public AgeDays: number;
    public Reason: string;
    public DurationMinutes: number;
    public IsCommercial: boolean;
    public PreferredCrewID?: number;

    public constructor(init?: Partial<ExceptionItem>) { (Object as any).assign(this, init); }
}

export class VisitExceptionsResponse
{
    public Items: ExceptionItem[] = [];
    public MissedCount: number;
    public SlaCount: number;
    public SkippedCount: number;
    public AtRiskCount: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<VisitExceptionsResponse>) { (Object as any).assign(this, init); }
}

export class VisitExceptionsRequest
{

    public constructor(init?: Partial<VisitExceptionsRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}