| GET,OPTIONS | /v1/inspections/{InspectionUID}/report |
|---|
"use strict";
export class InspectionPhoto {
/** @param {{AttachmentId?:string,FileName?:string,Url?:string,CreatedBy?:string,CreatedDate?:string,HasAnnotation?:boolean,AnnotatedAttachmentId?:string,AnnotatedUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
AttachmentId;
/** @type {string} */
FileName;
/** @type {string} */
Url;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedDate;
/** @type {boolean} */
HasAnnotation;
/** @type {?string} */
AnnotatedAttachmentId;
/** @type {string} */
AnnotatedUrl;
}
export class InspectionItem {
/** @param {{InspectionItemID?:number,InspectionID?:number,Seq?:number,Section?:string,Prompt?:string,ResponseType?:string,IsRequired?:boolean,Unit?:string,Guidance?:string,Result?:string,Value?:string,Notes?:string,PhotoCount?:number,LinkedPunchItemID?:number,LinkedPunchNo?:string,LinkedPunchStatus?:string,LinkedNcrID?:number,LinkedNcrNo?:string,LinkedActionID?:number,AnsweredBy?:string,AnsweredAt?:string,Photos?:InspectionPhoto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
InspectionItemID;
/** @type {number} */
InspectionID;
/** @type {number} */
Seq;
/** @type {string} */
Section;
/** @type {string} */
Prompt;
/** @type {string} */
ResponseType;
/** @type {boolean} */
IsRequired;
/** @type {string} */
Unit;
/** @type {string} */
Guidance;
/** @type {string} */
Result;
/** @type {string} */
Value;
/** @type {string} */
Notes;
/** @type {number} */
PhotoCount;
/** @type {?number} */
LinkedPunchItemID;
/** @type {string} */
LinkedPunchNo;
/** @type {string} */
LinkedPunchStatus;
/** @type {?number} */
LinkedNcrID;
/** @type {string} */
LinkedNcrNo;
/** @type {?number} */
LinkedActionID;
/** @type {string} */
AnsweredBy;
/** @type {?string} */
AnsweredAt;
/** @type {InspectionPhoto[]} */
Photos = [];
}
export class InspectionRequest {
/** @param {{InspectionRequestID?:number,InspectionID?:number,Agency?:string,ContactName?:string,ContactPhone?:string,PermitNo?:string,RequestedDate?:string,RequestedWindow?:string,Status?:string,ConfirmationNo?:string,Outcome?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
InspectionRequestID;
/** @type {number} */
InspectionID;
/** @type {string} */
Agency;
/** @type {string} */
ContactName;
/** @type {string} */
ContactPhone;
/** @type {string} */
PermitNo;
/** @type {?string} */
RequestedDate;
/** @type {string} */
RequestedWindow;
/** @type {string} */
Status;
/** @type {string} */
ConfirmationNo;
/** @type {string} */
Outcome;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {?string} */
UpdatedAt;
}
export class SignatureRecord {
/** @param {{SignatureRecordID?:number,EntityType?:string,EntityID?:number,Role?:string,SignerName?:string,SignerContactID?:number,SignerUserId?:string,Method?:string,ImageAttachmentId?:string,ImageUrl?:string,ImageHash?:string,DocumentHash?:string,ConsentText?:string,IpAddress?:string,UserAgent?:string,SignedAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SignatureRecordID;
/** @type {string} */
EntityType;
/** @type {number} */
EntityID;
/** @type {string} */
Role;
/** @type {string} */
SignerName;
/** @type {?number} */
SignerContactID;
/** @type {string} */
SignerUserId;
/** @type {string} */
Method;
/** @type {?string} */
ImageAttachmentId;
/** @type {string} */
ImageUrl;
/** @type {string} */
ImageHash;
/** @type {string} */
DocumentHash;
/** @type {string} */
ConsentText;
/** @type {string} */
IpAddress;
/** @type {string} */
UserAgent;
/** @type {?string} */
SignedAt;
}
export class Inspection {
/** @param {{InspectionID?:number,InspectionUID?:string,ProjectID?:number,ProjectName?:string,JobID?:number,JobName?:string,InspectionNo?:string,Type?:string,Title?:string,Status?:string,TemplateUID?:string,TemplateVersionNo?:number,ScheduledFor?:string,StartedAt?:string,CompletedAt?:string,ClosedAt?:string,InspectorContactID?:number,InspectorName?:string,AgencyName?:string,PermitNo?:string,LocationText?:string,Notes?:string,WeatherJson?:string,ItemsTotal?:number,ItemsPassed?:number,ItemsFailed?:number,Outcome?:string,OutcomeNotes?:string,ReinspectionOfInspectionID?:number,QcHoldPointID?:number,ReportAttachmentId?:string,RequestCount?:number,SignatureCount?:number,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,Items?:InspectionItem[],Requests?:InspectionRequest[],Signatures?:SignatureRecord[],Actions?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
InspectionID;
/** @type {string} */
InspectionUID;
/** @type {number} */
ProjectID;
/** @type {string} */
ProjectName;
/** @type {?number} */
JobID;
/** @type {string} */
JobName;
/** @type {string} */
InspectionNo;
/** @type {string} */
Type;
/** @type {string} */
Title;
/** @type {string} */
Status;
/** @type {?string} */
TemplateUID;
/** @type {?number} */
TemplateVersionNo;
/** @type {?string} */
ScheduledFor;
/** @type {?string} */
StartedAt;
/** @type {?string} */
CompletedAt;
/** @type {?string} */
ClosedAt;
/** @type {?number} */
InspectorContactID;
/** @type {string} */
InspectorName;
/** @type {string} */
AgencyName;
/** @type {string} */
PermitNo;
/** @type {string} */
LocationText;
/** @type {string} */
Notes;
/** @type {string} */
WeatherJson;
/** @type {number} */
ItemsTotal;
/** @type {number} */
ItemsPassed;
/** @type {number} */
ItemsFailed;
/** @type {string} */
Outcome;
/** @type {string} */
OutcomeNotes;
/** @type {?number} */
ReinspectionOfInspectionID;
/** @type {?number} */
QcHoldPointID;
/** @type {?string} */
ReportAttachmentId;
/** @type {number} */
RequestCount;
/** @type {number} */
SignatureCount;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {?string} */
UpdatedAt;
/** @type {InspectionItem[]} */
Items = [];
/** @type {InspectionRequest[]} */
Requests = [];
/** @type {SignatureRecord[]} */
Signatures = [];
/** @type {string[]} */
Actions = [];
}
export class InspectionReportSection {
/** @param {{Title?:string,Items?:InspectionItem[],Passed?:number,Failed?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Title;
/** @type {InspectionItem[]} */
Items = [];
/** @type {number} */
Passed;
/** @type {number} */
Failed;
}
export class InspectionReportResponse {
/** @param {{ResponseStatus?:ResponseStatus,Inspection?:Inspection,CompanyName?:string,ProjectName?:string,ProjectAddress?:string,ClientName?:string,Sections?:InspectionReportSection[],Signatures?:SignatureRecord[],SnapshotHash?:string,GeneratedAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Inspection} */
Inspection;
/** @type {string} */
CompanyName;
/** @type {string} */
ProjectName;
/** @type {string} */
ProjectAddress;
/** @type {string} */
ClientName;
/** @type {InspectionReportSection[]} */
Sections = [];
/** @type {SignatureRecord[]} */
Signatures = [];
/** @type {string} */
SnapshotHash;
/** @type {string} */
GeneratedAt;
}
export class InspectionReportRequest {
/** @param {{InspectionUID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
InspectionUID;
}
JavaScript InspectionReportRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/inspections/{InspectionUID}/report HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InspectionReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ClientName>String</ClientName>
<CompanyName>String</CompanyName>
<GeneratedAt>0001-01-01T00:00:00</GeneratedAt>
<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>
<ProjectAddress>String</ProjectAddress>
<ProjectName>String</ProjectName>
<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>
<Sections>
<InspectionReportSection>
<Failed>0</Failed>
<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>
<Passed>0</Passed>
<Title>String</Title>
</InspectionReportSection>
</Sections>
<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>
<SnapshotHash>String</SnapshotHash>
</InspectionReportResponse>