GET api/Areas/{id}/InspectionItems?withChildren={withChildren}
Returns the list of inspection items related to the given area.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Id of area. |
string |
Required |
| withChildren |
Returns the entire tree of children entities when true. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Returns the list of inspection items related to the given area.
Collection of CrmInspectionItem| Name | Description | Type | Additional information |
|---|---|---|---|
| Measurements |
List of measurements taken for inspection item. |
Collection of CrmMeasurement |
Optional |
| ProductsAndServices |
List of the related products and services guids. |
Collection of globally unique identifier |
Optional |
| Notes |
List of related notes. |
Collection of CrmNote |
Optional |
| Note |
Temp field to make Jeffrey happy. |
string |
Optional |
| Name |
Name of inspection item. |
string |
Optional |
| Condition |
Condition of inspection item. Must match a value in the picklist configured in CRM. |
string |
Optional |
| OccupancyCheck |
Indicates whether the inspection item is occupied or vacant. |
string |
Optional |
| Rating |
Rating given to the inspection item to indicate quality of item. |
string |
Optional |
| Rank3 |
Ranking given to inspection items to be ranked from 1 - 3 |
string |
Optional |
| Rank5 |
Ranking given to inspection items to be ranked from 1 - 5 |
string |
Optional |
| YesNo |
Ranking given to inspection items to be ranked from No to Yes |
string |
Optional |
| FenceCheck |
Raking given to inspection items to indicate Fence Repairs |
string |
Optional |
| UtilityCheck |
Indicates the state of the utilities for an inspection item. |
string |
Optional |
| Type |
Type of inspection item. Must match a value in the picklist configured in CRM. |
string |
Optional |
| AreaObject |
Used to reference the related area in CRM. |
EntityReference |
Optional |
| Media |
List of media items associated with the inspection item. |
Collection of CrmMedia |
Optional |
| Age |
Number of years estimating the age of an item. |
integer |
Optional |
| LifeExpectancy |
Number of years estimating the life expectancy of an item. |
integer |
Optional |
| IsRequired |
Indicates whether the inspection item is required or not. |
boolean |
Optional |
| Designation |
Reference to the entity that defines the designation for the name. |
EntityReference |
Optional |
| SortOrder |
Arbitrary Sort Index set in CRM |
integer |
Optional |
| Reference |
Used to reference the entity in CRM. |
EntityReference |
Optional |
| SystemDate |
Current system date of the client that created this object. |
date |
Optional |
| CapturedDate |
Date and time the client created this object. |
date |
Optional |
Response Formats
application/json, text/json
[
{
"Measurements": [
{
"Type": "sample string 1",
"Name": "sample string 2",
"Amount": 1.0,
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"InspectionItemObject": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"IsRequired": true,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
},
{
"Type": "sample string 1",
"Name": "sample string 2",
"Amount": 1.0,
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"InspectionItemObject": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"IsRequired": true,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
}
],
"ProductsAndServices": [
"da0c7bdc-de8f-46f6-b729-a0131ea45569",
"0e93fa55-463b-4212-b767-2dbe39f2e22e"
],
"Notes": [
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-10-30T10:29:22.8561939-05:00",
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
},
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-10-30T10:29:22.8561939-05:00",
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
}
],
"Note": "sample string 1",
"Name": "sample string 2",
"Condition": "sample string 3",
"OccupancyCheck": "sample string 4",
"Rating": "sample string 5",
"Rank3": "sample string 6",
"Rank5": "sample string 7",
"YesNo": "sample string 8",
"FenceCheck": "sample string 9",
"UtilityCheck": "sample string 10",
"Type": "sample string 11",
"AreaObject": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Media": [
{
"MediaId": 1,
"Tags": [
"sample string 1",
"sample string 2"
],
"Data": "sample string 2",
"Name": "sample string 3",
"Caption": "sample string 4",
"MediaKey": "sample string 5",
"Ordinal": 6,
"MimeType": "sample string 7",
"Url": "sample string 8",
"Latitude": 1.1,
"Longitude": 1.1,
"IsAnnotation": true,
"IsThumbnail": true,
"Height": 1,
"Width": 1,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
},
{
"MediaId": 1,
"Tags": [
"sample string 1",
"sample string 2"
],
"Data": "sample string 2",
"Name": "sample string 3",
"Caption": "sample string 4",
"MediaKey": "sample string 5",
"Ordinal": 6,
"MimeType": "sample string 7",
"Url": "sample string 8",
"Latitude": 1.1,
"Longitude": 1.1,
"IsAnnotation": true,
"IsThumbnail": true,
"Height": 1,
"Width": 1,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
}
],
"Age": 1,
"LifeExpectancy": 1,
"IsRequired": true,
"Designation": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SortOrder": 12,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
},
{
"Measurements": [
{
"Type": "sample string 1",
"Name": "sample string 2",
"Amount": 1.0,
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"InspectionItemObject": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"IsRequired": true,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
},
{
"Type": "sample string 1",
"Name": "sample string 2",
"Amount": 1.0,
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"InspectionItemObject": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"IsRequired": true,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
}
],
"ProductsAndServices": [
"da0c7bdc-de8f-46f6-b729-a0131ea45569",
"0e93fa55-463b-4212-b767-2dbe39f2e22e"
],
"Notes": [
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-10-30T10:29:22.8561939-05:00",
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
},
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-10-30T10:29:22.8561939-05:00",
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
}
],
"Note": "sample string 1",
"Name": "sample string 2",
"Condition": "sample string 3",
"OccupancyCheck": "sample string 4",
"Rating": "sample string 5",
"Rank3": "sample string 6",
"Rank5": "sample string 7",
"YesNo": "sample string 8",
"FenceCheck": "sample string 9",
"UtilityCheck": "sample string 10",
"Type": "sample string 11",
"AreaObject": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Media": [
{
"MediaId": 1,
"Tags": [
"sample string 1",
"sample string 2"
],
"Data": "sample string 2",
"Name": "sample string 3",
"Caption": "sample string 4",
"MediaKey": "sample string 5",
"Ordinal": 6,
"MimeType": "sample string 7",
"Url": "sample string 8",
"Latitude": 1.1,
"Longitude": 1.1,
"IsAnnotation": true,
"IsThumbnail": true,
"Height": 1,
"Width": 1,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
},
{
"MediaId": 1,
"Tags": [
"sample string 1",
"sample string 2"
],
"Data": "sample string 2",
"Name": "sample string 3",
"Caption": "sample string 4",
"MediaKey": "sample string 5",
"Ordinal": 6,
"MimeType": "sample string 7",
"Url": "sample string 8",
"Latitude": 1.1,
"Longitude": 1.1,
"IsAnnotation": true,
"IsThumbnail": true,
"Height": 1,
"Width": 1,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
}
],
"Age": 1,
"LifeExpectancy": 1,
"IsRequired": true,
"Designation": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SortOrder": 12,
"Reference": {
"Id": "1d0d3df4-d90b-4726-bd0a-7ad6e718d90e",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:29:22.8561939-05:00",
"CapturedDate": "2025-10-30T10:29:22.8561939-05:00"
}
]