GET api/Areas/{id}
Returns an area by id. Note: Requires a valid access token to be provided in the request's auth header.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Id of area. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns an area by id.
CrmArea| Name | Description | Type | Additional information |
|---|---|---|---|
| InspectionItems |
List of related inspection items. |
Collection of CrmInspectionItem |
Optional |
| Notes |
List of related notes. |
Collection of CrmNote |
Optional |
| Name |
Name of area. |
string |
Required |
| InspectionObject |
Used to reference the related inspection in CRM. |
EntityReference |
Optional |
| Reference |
Used to reference the area in CRM. |
EntityReference |
Required |
| Designation |
Reference to the entity that defines the designation for the name. |
EntityReference |
Optional |
| Media |
List of media items associated with the area. |
Collection of CrmMedia |
Optional |
| SortOrder |
Arbitrary Sort Index set in CRM |
integer |
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
Sample:
{
"InspectionItems": [
{
"Measurements": [
{
"Type": "sample string 1",
"Name": "sample string 2",
"Amount": 1.0,
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"InspectionItemObject": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"IsRequired": true,
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
},
{
"Type": "sample string 1",
"Name": "sample string 2",
"Amount": 1.0,
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"InspectionItemObject": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"IsRequired": true,
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
}
],
"ProductsAndServices": [
"78a979e2-408b-46dc-ab41-d8fc03876922",
"de8eab6c-a858-47f7-b7dc-549842e99b9c"
],
"Notes": [
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-05-23T16:08:34.1307788-05:00",
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
},
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-05-23T16:08:34.1307788-05:00",
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-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": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"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": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-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": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
}
],
"Age": 1,
"LifeExpectancy": 1,
"IsRequired": true,
"Designation": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SortOrder": 12,
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-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": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"IsRequired": true,
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
},
{
"Type": "sample string 1",
"Name": "sample string 2",
"Amount": 1.0,
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"InspectionItemObject": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"IsRequired": true,
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
}
],
"ProductsAndServices": [
"78a979e2-408b-46dc-ab41-d8fc03876922",
"de8eab6c-a858-47f7-b7dc-549842e99b9c"
],
"Notes": [
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-05-23T16:08:34.1307788-05:00",
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
},
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-05-23T16:08:34.1307788-05:00",
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-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": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"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": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-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": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
}
],
"Age": 1,
"LifeExpectancy": 1,
"IsRequired": true,
"Designation": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SortOrder": 12,
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
}
],
"Notes": [
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-05-23T16:08:34.1307788-05:00",
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
},
{
"Name": "sample string 1",
"Content": "sample string 2",
"CreatedBy": "sample string 3",
"CreatedOn": "2025-05-23T16:08:34.1307788-05:00",
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
}
],
"Name": "sample string 1",
"InspectionObject": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Reference": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Designation": {
"Id": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"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": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-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": "6744098a-4f4d-48aa-bd5a-e297194d4c80",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
}
],
"SortOrder": 2,
"SystemDate": "2025-05-23T16:08:34.1307788-05:00",
"CapturedDate": "2025-05-23T16:08:34.1307788-05:00"
}