Trendsic Platform Service

<back to all web services

InspectionCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/inspections
InspectionCreateRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
JobIDbodyint?No
TypebodystringNo
TitlebodystringNo
TemplateUIDbodyGuid?No
ScheduledForbodyDateTime?No
InspectorContactIDbodyint?No
InspectorNamebodystringNo
AgencyNamebodystringNo
PermitNobodystringNo
LocationTextbodystringNo
NotesbodystringNo
QcHoldPointIDbodyint?No
ItemsbodyList<InspectionItem>No
InspectionItem Parameters:
NameParameterData TypeRequiredDescription
InspectionItemIDformintNo
InspectionIDformintNo
SeqformintNo
SectionformstringNo
PromptformstringNo
ResponseTypeformstringNo
IsRequiredformboolNo
UnitformstringNo
GuidanceformstringNo
ResultformstringNo
ValueformstringNo
NotesformstringNo
PhotoCountformintNo
LinkedPunchItemIDformint?No
LinkedPunchNoformstringNo
LinkedPunchStatusformstringNo
LinkedNcrIDformint?No
LinkedNcrNoformstringNo
LinkedActionIDformint?No
AnsweredByformstringNo
AnsweredAtformDateTime?No
PhotosformList<InspectionPhoto>No
InspectionPhoto Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdformGuidNo
FileNameformstringNo
UrlformstringNo
CreatedByformstringNo
CreatedDateformDateTime?No
HasAnnotationformboolNo
AnnotatedAttachmentIdformGuid?No
AnnotatedUrlformstringNo
InspectionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
InspectionformInspectionNo
Inspection Parameters:
NameParameterData TypeRequiredDescription
InspectionIDformintNo
InspectionUIDformGuidNo
ProjectIDformintNo
ProjectNameformstringNo
JobIDformint?No
JobNameformstringNo
InspectionNoformstringNo
TypeformstringNo
TitleformstringNo
StatusformstringNo
TemplateUIDformGuid?No
TemplateVersionNoformint?No
ScheduledForformDateTime?No
StartedAtformDateTime?No
CompletedAtformDateTime?No
ClosedAtformDateTime?No
InspectorContactIDformint?No
InspectorNameformstringNo
AgencyNameformstringNo
PermitNoformstringNo
LocationTextformstringNo
NotesformstringNo
WeatherJsonformstringNo
ItemsTotalformintNo
ItemsPassedformintNo
ItemsFailedformintNo
OutcomeformstringNo
OutcomeNotesformstringNo
ReinspectionOfInspectionIDformint?No
QcHoldPointIDformint?No
ReportAttachmentIdformGuid?No
RequestCountformintNo
SignatureCountformintNo
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
ItemsformList<InspectionItem>No
RequestsformList<InspectionRequest>No
SignaturesformList<SignatureRecord>No
ActionsformList<string>No
InspectionRequest Parameters:
NameParameterData TypeRequiredDescription
InspectionRequestIDformintNo
InspectionIDformintNo
AgencyformstringNo
ContactNameformstringNo
ContactPhoneformstringNo
PermitNoformstringNo
RequestedDateformDateTime?No
RequestedWindowformstringNo
StatusformstringNo
ConfirmationNoformstringNo
OutcomeformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
SignatureRecord Parameters:
NameParameterData TypeRequiredDescription
SignatureRecordIDformintNo
EntityTypeformstringNo
EntityIDformintNo
RoleformstringNo
SignerNameformstringNo
SignerContactIDformint?No
SignerUserIdformstringNo
MethodformstringNo
ImageAttachmentIdformGuid?No
ImageUrlformstringNo
ImageHashformstringNo
DocumentHashformstringNo
ConsentTextformstringNo
IpAddressformstringNo
UserAgentformstringNo
SignedAtformDateTime?No

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.

POST /v1/projects/{ProjectID}/inspections HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InspectionCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgencyName>String</AgencyName>
  <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>
  <JobID>0</JobID>
  <LocationText>String</LocationText>
  <Notes>String</Notes>
  <PermitNo>String</PermitNo>
  <ProjectID>0</ProjectID>
  <QcHoldPointID>0</QcHoldPointID>
  <ScheduledFor>0001-01-01T00:00:00</ScheduledFor>
  <TemplateUID>00000000-0000-0000-0000-000000000000</TemplateUID>
  <Title>String</Title>
  <Type>String</Type>
</InspectionCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InspectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Inspection>
    <Actions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1: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>
  <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>
</InspectionResponse>