Trendsic Platform Service

<back to all web services

InspectionListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/inspections
InspectionListRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
StatusquerystringNo
TypequerystringNo
OnDatequerystringNo
InspectionListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
InspectionsformList<Inspection>No
SummaryformInspectionSummaryNo
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
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
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
InspectionSummary Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
DueTodayformintNo
OverdueformintNo
InProgressformintNo
FailedformintNo
ConditionalformintNo
PassedOpenformintNo
ClosedformintNo
Completed30dformintNo
Passed30dformintNo
HeadlineformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/projects/{ProjectID}/inspections HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Inspections":[{"InspectionID":0,"InspectionUID":"00000000000000000000000000000000","ProjectID":0,"ProjectName":"String","JobID":0,"JobName":"String","InspectionNo":"String","Type":"String","Title":"String","Status":"String","TemplateUID":"00000000000000000000000000000000","TemplateVersionNo":0,"ScheduledFor":"0001-01-01T00:00:00.0000000","StartedAt":"0001-01-01T00:00:00.0000000","CompletedAt":"0001-01-01T00:00:00.0000000","ClosedAt":"0001-01-01T00:00:00.0000000","InspectorContactID":0,"InspectorName":"String","AgencyName":"String","PermitNo":"String","LocationText":"String","Notes":"String","WeatherJson":"String","ItemsTotal":0,"ItemsPassed":0,"ItemsFailed":0,"Outcome":"String","OutcomeNotes":"String","ReinspectionOfInspectionID":0,"QcHoldPointID":0,"ReportAttachmentId":"00000000000000000000000000000000","RequestCount":0,"SignatureCount":0,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","Items":[{"InspectionItemID":0,"InspectionID":0,"Seq":0,"Section":"String","Prompt":"String","ResponseType":"String","IsRequired":false,"Unit":"String","Guidance":"String","Result":"String","Value":"String","Notes":"String","PhotoCount":0,"LinkedPunchItemID":0,"LinkedPunchNo":"String","LinkedPunchStatus":"String","LinkedNcrID":0,"LinkedNcrNo":"String","LinkedActionID":0,"AnsweredBy":"String","AnsweredAt":"0001-01-01T00:00:00.0000000","Photos":[{"AttachmentId":"00000000000000000000000000000000","FileName":"String","Url":"String","CreatedBy":"String","CreatedDate":"0001-01-01T00:00:00.0000000","HasAnnotation":false,"AnnotatedAttachmentId":"00000000000000000000000000000000","AnnotatedUrl":"String"}]}],"Requests":[{"InspectionRequestID":0,"InspectionID":0,"Agency":"String","ContactName":"String","ContactPhone":"String","PermitNo":"String","RequestedDate":"0001-01-01T00:00:00.0000000","RequestedWindow":"String","Status":"String","ConfirmationNo":"String","Outcome":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"Signatures":[{"SignatureRecordID":0,"EntityType":"String","EntityID":0,"Role":"String","SignerName":"String","SignerContactID":0,"SignerUserId":"String","Method":"String","ImageAttachmentId":"00000000000000000000000000000000","ImageUrl":"String","ImageHash":"String","DocumentHash":"String","ConsentText":"String","IpAddress":"String","UserAgent":"String","SignedAt":"0001-01-01T00:00:00.0000000"}],"Actions":["String"]}],"Summary":{"Total":0,"DueToday":0,"Overdue":0,"InProgress":0,"Failed":0,"Conditional":0,"PassedOpen":0,"Closed":0,"Completed30d":0,"Passed30d":0,"Headline":"String"}}