Trendsic Platform Service

<back to all web services

InspectionDueRequest

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


open class InspectionDueRequest
{
    open var ProjectID:Int? = null
}

open class InspectionListResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Inspections:ArrayList<Inspection> = ArrayList<Inspection>()
    open var Summary:InspectionSummary? = null
}

open class Inspection
{
    open var InspectionID:Int? = null
    open var InspectionUID:UUID? = null
    open var ProjectID:Int? = null
    open var ProjectName:String? = null
    open var JobID:Int? = null
    open var JobName:String? = null
    open var InspectionNo:String? = null
    open var Type:String? = null
    open var Title:String? = null
    open var Status:String? = null
    open var TemplateUID:UUID? = null
    open var TemplateVersionNo:Int? = null
    open var ScheduledFor:Date? = null
    open var StartedAt:Date? = null
    open var CompletedAt:Date? = null
    open var ClosedAt:Date? = null
    open var InspectorContactID:Int? = null
    open var InspectorName:String? = null
    open var AgencyName:String? = null
    open var PermitNo:String? = null
    open var LocationText:String? = null
    open var Notes:String? = null
    open var WeatherJson:String? = null
    open var ItemsTotal:Int? = null
    open var ItemsPassed:Int? = null
    open var ItemsFailed:Int? = null
    open var Outcome:String? = null
    open var OutcomeNotes:String? = null
    open var ReinspectionOfInspectionID:Int? = null
    open var QcHoldPointID:Int? = null
    open var ReportAttachmentId:UUID? = null
    open var RequestCount:Int? = null
    open var SignatureCount:Int? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var UpdatedAt:Date? = null
    open var Items:ArrayList<InspectionItem> = ArrayList<InspectionItem>()
    open var Requests:ArrayList<InspectionRequest> = ArrayList<InspectionRequest>()
    open var Signatures:ArrayList<SignatureRecord> = ArrayList<SignatureRecord>()
    open var Actions:ArrayList<String> = ArrayList<String>()
}

open class InspectionItem
{
    open var InspectionItemID:Int? = null
    open var InspectionID:Int? = null
    open var Seq:Int? = null
    open var Section:String? = null
    open var Prompt:String? = null
    open var ResponseType:String? = null
    open var IsRequired:Boolean? = null
    open var Unit:String? = null
    open var Guidance:String? = null
    open var Result:String? = null
    open var Value:String? = null
    open var Notes:String? = null
    open var PhotoCount:Int? = null
    open var LinkedPunchItemID:Int? = null
    open var LinkedPunchNo:String? = null
    open var LinkedPunchStatus:String? = null
    open var LinkedNcrID:Int? = null
    open var LinkedNcrNo:String? = null
    open var LinkedActionID:Int? = null
    open var AnsweredBy:String? = null
    open var AnsweredAt:Date? = null
    open var Photos:ArrayList<InspectionPhoto> = ArrayList<InspectionPhoto>()
}

open class InspectionPhoto
{
    open var AttachmentId:UUID? = null
    open var FileName:String? = null
    open var Url:String? = null
    open var CreatedBy:String? = null
    open var CreatedDate:Date? = null
    open var HasAnnotation:Boolean? = null
    open var AnnotatedAttachmentId:UUID? = null
    open var AnnotatedUrl:String? = null
}

open class InspectionRequest
{
    open var InspectionRequestID:Int? = null
    open var InspectionID:Int? = null
    open var Agency:String? = null
    open var ContactName:String? = null
    open var ContactPhone:String? = null
    open var PermitNo:String? = null
    open var RequestedDate:Date? = null
    open var RequestedWindow:String? = null
    open var Status:String? = null
    open var ConfirmationNo:String? = null
    open var Outcome:String? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var UpdatedAt:Date? = null
}

open class SignatureRecord
{
    open var SignatureRecordID:Int? = null
    open var EntityType:String? = null
    open var EntityID:Int? = null
    open var Role:String? = null
    open var SignerName:String? = null
    open var SignerContactID:Int? = null
    open var SignerUserId:String? = null
    open var Method:String? = null
    open var ImageAttachmentId:UUID? = null
    open var ImageUrl:String? = null
    open var ImageHash:String? = null
    open var DocumentHash:String? = null
    open var ConsentText:String? = null
    open var IpAddress:String? = null
    open var UserAgent:String? = null
    open var SignedAt:Date? = null
}

open class InspectionSummary
{
    open var Total:Int? = null
    open var DueToday:Int? = null
    open var Overdue:Int? = null
    open var InProgress:Int? = null
    open var Failed:Int? = null
    open var Conditional:Int? = null
    open var PassedOpen:Int? = null
    open var Closed:Int? = null
    open var Completed30d:Int? = null
    open var Passed30d:Int? = null
    open var Headline:String? = null
}

Kotlin InspectionDueRequest 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/inspections/due HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InspectionListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Inspections>
    <Inspection>
      <Actions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Actions>
      <AgencyName>String</AgencyName>
      <ClosedAt>0001-01-01T00:00:00</ClosedAt>
      <CompletedAt>0001-01-01T00:00:00</CompletedAt>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <InspectionID>0</InspectionID>
      <InspectionNo>String</InspectionNo>
      <InspectionUID>00000000-0000-0000-0000-000000000000</InspectionUID>
      <InspectorContactID>0</InspectorContactID>
      <InspectorName>String</InspectorName>
      <Items>
        <InspectionItem>
          <AnsweredAt>0001-01-01T00:00:00</AnsweredAt>
          <AnsweredBy>String</AnsweredBy>
          <Guidance>String</Guidance>
          <InspectionID>0</InspectionID>
          <InspectionItemID>0</InspectionItemID>
          <IsRequired>false</IsRequired>
          <LinkedActionID>0</LinkedActionID>
          <LinkedNcrID>0</LinkedNcrID>
          <LinkedNcrNo>String</LinkedNcrNo>
          <LinkedPunchItemID>0</LinkedPunchItemID>
          <LinkedPunchNo>String</LinkedPunchNo>
          <LinkedPunchStatus>String</LinkedPunchStatus>
          <Notes>String</Notes>
          <PhotoCount>0</PhotoCount>
          <Photos>
            <InspectionPhoto>
              <AnnotatedAttachmentId>00000000-0000-0000-0000-000000000000</AnnotatedAttachmentId>
              <AnnotatedUrl>String</AnnotatedUrl>
              <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
              <CreatedBy>String</CreatedBy>
              <CreatedDate>0001-01-01T00:00:00</CreatedDate>
              <FileName>String</FileName>
              <HasAnnotation>false</HasAnnotation>
              <Url>String</Url>
            </InspectionPhoto>
          </Photos>
          <Prompt>String</Prompt>
          <ResponseType>String</ResponseType>
          <Result>String</Result>
          <Section>String</Section>
          <Seq>0</Seq>
          <Unit>String</Unit>
          <Value>String</Value>
        </InspectionItem>
      </Items>
      <ItemsFailed>0</ItemsFailed>
      <ItemsPassed>0</ItemsPassed>
      <ItemsTotal>0</ItemsTotal>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <LocationText>String</LocationText>
      <Notes>String</Notes>
      <Outcome>String</Outcome>
      <OutcomeNotes>String</OutcomeNotes>
      <PermitNo>String</PermitNo>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <QcHoldPointID>0</QcHoldPointID>
      <ReinspectionOfInspectionID>0</ReinspectionOfInspectionID>
      <ReportAttachmentId>00000000-0000-0000-0000-000000000000</ReportAttachmentId>
      <RequestCount>0</RequestCount>
      <Requests>
        <InspectionRequest>
          <Agency>String</Agency>
          <ConfirmationNo>String</ConfirmationNo>
          <ContactName>String</ContactName>
          <ContactPhone>String</ContactPhone>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <InspectionID>0</InspectionID>
          <InspectionRequestID>0</InspectionRequestID>
          <Outcome>String</Outcome>
          <PermitNo>String</PermitNo>
          <RequestedDate>0001-01-01T00:00:00</RequestedDate>
          <RequestedWindow>String</RequestedWindow>
          <Status>String</Status>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
        </InspectionRequest>
      </Requests>
      <ScheduledFor>0001-01-01T00:00:00</ScheduledFor>
      <SignatureCount>0</SignatureCount>
      <Signatures>
        <SignatureRecord>
          <ConsentText>String</ConsentText>
          <DocumentHash>String</DocumentHash>
          <EntityID>0</EntityID>
          <EntityType>String</EntityType>
          <ImageAttachmentId>00000000-0000-0000-0000-000000000000</ImageAttachmentId>
          <ImageHash>String</ImageHash>
          <ImageUrl>String</ImageUrl>
          <IpAddress>String</IpAddress>
          <Method>String</Method>
          <Role>String</Role>
          <SignatureRecordID>0</SignatureRecordID>
          <SignedAt>0001-01-01T00:00:00</SignedAt>
          <SignerContactID>0</SignerContactID>
          <SignerName>String</SignerName>
          <SignerUserId>String</SignerUserId>
          <UserAgent>String</UserAgent>
        </SignatureRecord>
      </Signatures>
      <StartedAt>0001-01-01T00:00:00</StartedAt>
      <Status>String</Status>
      <TemplateUID>00000000-0000-0000-0000-000000000000</TemplateUID>
      <TemplateVersionNo>0</TemplateVersionNo>
      <Title>String</Title>
      <Type>String</Type>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <WeatherJson>String</WeatherJson>
    </Inspection>
  </Inspections>
  <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>
  <Summary>
    <Closed>0</Closed>
    <Completed30d>0</Completed30d>
    <Conditional>0</Conditional>
    <DueToday>0</DueToday>
    <Failed>0</Failed>
    <Headline>String</Headline>
    <InProgress>0</InProgress>
    <Overdue>0</Overdue>
    <Passed30d>0</Passed30d>
    <PassedOpen>0</PassedOpen>
    <Total>0</Total>
  </Summary>
</InspectionListResponse>