| GET,OPTIONS | /v1/projects/{ProjectID}/inspections/idr |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProjectID | path | int | No | |
| Date | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| ProjectID | form | int | No | |
| ProjectName | form | string | No | |
| ReportDate | form | DateTime | No | |
| CompanyName | form | string | No | |
| Weather | form | string | No | |
| TempF | form | int? | No | |
| WeatherDelayHours | form | double? | No | |
| HasFieldLog | form | bool | No | |
| FieldLogStatus | form | string | No | |
| FieldLogSubmittedBy | form | string | No | |
| Notes | form | string | No | |
| Crew | form | List<IdrLine> | No | |
| Subs | form | List<IdrLine> | No | |
| Equipment | form | List<IdrLine> | No | |
| Quantities | form | List<IdrLine> | No | |
| Deliveries | form | List<IdrLine> | No | |
| Incidents | form | List<IdrLine> | No | |
| CrewHoursTotal | form | double | No | |
| Inspections | form | List<Inspection> | No | |
| Signatures | form | List<SignatureRecord> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | No | |
| Detail | form | string | No | |
| Qty | form | double? | No | |
| Unit | form | string | No | |
| Hours | form | double? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InspectionID | form | int | No | |
| InspectionUID | form | Guid | No | |
| ProjectID | form | int | No | |
| ProjectName | form | string | No | |
| JobID | form | int? | No | |
| JobName | form | string | No | |
| InspectionNo | form | string | No | |
| Type | form | string | No | |
| Title | form | string | No | |
| Status | form | string | No | |
| TemplateUID | form | Guid? | No | |
| TemplateVersionNo | form | int? | No | |
| ScheduledFor | form | DateTime? | No | |
| StartedAt | form | DateTime? | No | |
| CompletedAt | form | DateTime? | No | |
| ClosedAt | form | DateTime? | No | |
| InspectorContactID | form | int? | No | |
| InspectorName | form | string | No | |
| AgencyName | form | string | No | |
| PermitNo | form | string | No | |
| LocationText | form | string | No | |
| Notes | form | string | No | |
| WeatherJson | form | string | No | |
| ItemsTotal | form | int | No | |
| ItemsPassed | form | int | No | |
| ItemsFailed | form | int | No | |
| Outcome | form | string | No | |
| OutcomeNotes | form | string | No | |
| ReinspectionOfInspectionID | form | int? | No | |
| QcHoldPointID | form | int? | No | |
| ReportAttachmentId | form | Guid? | No | |
| RequestCount | form | int | No | |
| SignatureCount | form | int | No | |
| CreatedBy | form | string | No | |
| CreatedAt | form | DateTime? | No | |
| UpdatedAt | form | DateTime? | No | |
| Items | form | List<InspectionItem> | No | |
| Requests | form | List<InspectionRequest> | No | |
| Signatures | form | List<SignatureRecord> | No | |
| Actions | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InspectionItemID | form | int | No | |
| InspectionID | form | int | No | |
| Seq | form | int | No | |
| Section | form | string | No | |
| Prompt | form | string | No | |
| ResponseType | form | string | No | |
| IsRequired | form | bool | No | |
| Unit | form | string | No | |
| Guidance | form | string | No | |
| Result | form | string | No | |
| Value | form | string | No | |
| Notes | form | string | No | |
| PhotoCount | form | int | No | |
| LinkedPunchItemID | form | int? | No | |
| LinkedPunchNo | form | string | No | |
| LinkedPunchStatus | form | string | No | |
| LinkedNcrID | form | int? | No | |
| LinkedNcrNo | form | string | No | |
| LinkedActionID | form | int? | No | |
| AnsweredBy | form | string | No | |
| AnsweredAt | form | DateTime? | No | |
| Photos | form | List<InspectionPhoto> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttachmentId | form | Guid | No | |
| FileName | form | string | No | |
| Url | form | string | No | |
| CreatedBy | form | string | No | |
| CreatedDate | form | DateTime? | No | |
| HasAnnotation | form | bool | No | |
| AnnotatedAttachmentId | form | Guid? | No | |
| AnnotatedUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InspectionRequestID | form | int | No | |
| InspectionID | form | int | No | |
| Agency | form | string | No | |
| ContactName | form | string | No | |
| ContactPhone | form | string | No | |
| PermitNo | form | string | No | |
| RequestedDate | form | DateTime? | No | |
| RequestedWindow | form | string | No | |
| Status | form | string | No | |
| ConfirmationNo | form | string | No | |
| Outcome | form | string | No | |
| CreatedBy | form | string | No | |
| CreatedAt | form | DateTime? | No | |
| UpdatedAt | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SignatureRecordID | form | int | No | |
| EntityType | form | string | No | |
| EntityID | form | int | No | |
| Role | form | string | No | |
| SignerName | form | string | No | |
| SignerContactID | form | int? | No | |
| SignerUserId | form | string | No | |
| Method | form | string | No | |
| ImageAttachmentId | form | Guid? | No | |
| ImageUrl | form | string | No | |
| ImageHash | form | string | No | |
| DocumentHash | form | string | No | |
| ConsentText | form | string | No | |
| IpAddress | form | string | No | |
| UserAgent | form | string | No | |
| SignedAt | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/projects/{ProjectID}/inspections/idr HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
ProjectID: 0,
ProjectName: String,
ReportDate: 0001-01-01,
CompanyName: String,
Weather: String,
TempF: 0,
WeatherDelayHours: 0,
HasFieldLog: False,
FieldLogStatus: String,
FieldLogSubmittedBy: String,
Notes: String,
Crew:
[
{
Label: String,
Detail: String,
Qty: 0,
Unit: String,
Hours: 0
}
],
Subs:
[
{
Label: String,
Detail: String,
Qty: 0,
Unit: String,
Hours: 0
}
],
Equipment:
[
{
Label: String,
Detail: String,
Qty: 0,
Unit: String,
Hours: 0
}
],
Quantities:
[
{
Label: String,
Detail: String,
Qty: 0,
Unit: String,
Hours: 0
}
],
Deliveries:
[
{
Label: String,
Detail: String,
Qty: 0,
Unit: String,
Hours: 0
}
],
Incidents:
[
{
Label: String,
Detail: String,
Qty: 0,
Unit: String,
Hours: 0
}
],
CrewHoursTotal: 0,
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-01,
StartedAt: 0001-01-01,
CompletedAt: 0001-01-01,
ClosedAt: 0001-01-01,
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-01,
UpdatedAt: 0001-01-01,
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-01,
Photos:
[
{
AttachmentId: 00000000000000000000000000000000,
FileName: String,
Url: String,
CreatedBy: String,
CreatedDate: 0001-01-01,
HasAnnotation: False,
AnnotatedAttachmentId: 00000000000000000000000000000000,
AnnotatedUrl: String
}
]
}
],
Requests:
[
{
InspectionRequestID: 0,
InspectionID: 0,
Agency: String,
ContactName: String,
ContactPhone: String,
PermitNo: String,
RequestedDate: 0001-01-01,
RequestedWindow: String,
Status: String,
ConfirmationNo: String,
Outcome: String,
CreatedBy: String,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01
}
],
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-01
}
],
Actions:
[
String
]
}
],
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-01
}
]
}