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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VisitExceptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AtRiskCount>0</AtRiskCount>
  <Items>
    <ExceptionItem>
      <AgeDays>0</AgeDays>
      <AgreementID>0</AgreementID>
      <AgreementJobID>0</AgreementJobID>
      <City>String</City>
      <CustomerName>String</CustomerName>
      <DurationMinutes>0</DurationMinutes>
      <IsCommercial>false</IsCommercial>
      <JobID>0</JobID>
      <Kind>String</Kind>
      <Lat>0</Lat>
      <Lng>0</Lng>
      <LocationName>String</LocationName>
      <OccurrenceDate>String</OccurrenceDate>
      <PreferredCrewID>0</PreferredCrewID>
      <ProjectID>0</ProjectID>
      <Reason>String</Reason>
      <VisitKey>String</VisitKey>
    </ExceptionItem>
  </Items>
  <MissedCount>0</MissedCount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SkippedCount>0</SkippedCount>
  <SlaCount>0</SlaCount>
</VisitExceptionsResponse>