Trendsic Platform Service

<back to all web services

VisitExceptionsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/exceptions
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class VisitExceptionsRequest
    {
        
    }

    public static class VisitExceptionsResponse
    {
        public ArrayList<ExceptionItem> Items = new ArrayList<ExceptionItem>();
        public Integer MissedCount = null;
        public Integer SlaCount = null;
        public Integer SkippedCount = null;
        public Integer AtRiskCount = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ExceptionItem> getItems() { return Items; }
        public VisitExceptionsResponse setItems(ArrayList<ExceptionItem> value) { this.Items = value; return this; }
        public Integer getMissedCount() { return MissedCount; }
        public VisitExceptionsResponse setMissedCount(Integer value) { this.MissedCount = value; return this; }
        public Integer getSlaCount() { return SlaCount; }
        public VisitExceptionsResponse setSlaCount(Integer value) { this.SlaCount = value; return this; }
        public Integer getSkippedCount() { return SkippedCount; }
        public VisitExceptionsResponse setSkippedCount(Integer value) { this.SkippedCount = value; return this; }
        public Integer getAtRiskCount() { return AtRiskCount; }
        public VisitExceptionsResponse setAtRiskCount(Integer value) { this.AtRiskCount = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public VisitExceptionsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ExceptionItem
    {
        public String Kind = null;
        public String VisitKey = null;
        public Integer JobID = null;
        public Integer ProjectID = null;
        public Integer AgreementID = null;
        public Integer AgreementJobID = null;
        public String OccurrenceDate = null;
        public String CustomerName = null;
        public String LocationName = null;
        public String City = null;
        public Double Lat = null;
        public Double Lng = null;
        public Integer AgeDays = null;
        public String Reason = null;
        public Integer DurationMinutes = null;
        public Boolean IsCommercial = null;
        public Integer PreferredCrewID = null;
        
        public String getKind() { return Kind; }
        public ExceptionItem setKind(String value) { this.Kind = value; return this; }
        public String getVisitKey() { return VisitKey; }
        public ExceptionItem setVisitKey(String value) { this.VisitKey = value; return this; }
        public Integer getJobID() { return JobID; }
        public ExceptionItem setJobID(Integer value) { this.JobID = value; return this; }
        public Integer getProjectID() { return ProjectID; }
        public ExceptionItem setProjectID(Integer value) { this.ProjectID = value; return this; }
        public Integer getAgreementID() { return AgreementID; }
        public ExceptionItem setAgreementID(Integer value) { this.AgreementID = value; return this; }
        public Integer getAgreementJobID() { return AgreementJobID; }
        public ExceptionItem setAgreementJobID(Integer value) { this.AgreementJobID = value; return this; }
        public String getOccurrenceDate() { return OccurrenceDate; }
        public ExceptionItem setOccurrenceDate(String value) { this.OccurrenceDate = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public ExceptionItem setCustomerName(String value) { this.CustomerName = value; return this; }
        public String getLocationName() { return LocationName; }
        public ExceptionItem setLocationName(String value) { this.LocationName = value; return this; }
        public String getCity() { return City; }
        public ExceptionItem setCity(String value) { this.City = value; return this; }
        public Double getLat() { return Lat; }
        public ExceptionItem setLat(Double value) { this.Lat = value; return this; }
        public Double getLng() { return Lng; }
        public ExceptionItem setLng(Double value) { this.Lng = value; return this; }
        public Integer getAgeDays() { return AgeDays; }
        public ExceptionItem setAgeDays(Integer value) { this.AgeDays = value; return this; }
        public String getReason() { return Reason; }
        public ExceptionItem setReason(String value) { this.Reason = value; return this; }
        public Integer getDurationMinutes() { return DurationMinutes; }
        public ExceptionItem setDurationMinutes(Integer value) { this.DurationMinutes = value; return this; }
        public Boolean getIsCommercial() { return IsCommercial; }
        public ExceptionItem setIsCommercial(Boolean value) { this.IsCommercial = value; return this; }
        public Integer getPreferredCrewID() { return PreferredCrewID; }
        public ExceptionItem setPreferredCrewID(Integer value) { this.PreferredCrewID = value; return this; }
    }

}

Java 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>