GET api/property/{id}
Get a property by its Id Processes this property API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the property to get. Pass 0 to be returned an empty data contract. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The property or null if it does not exist
PropertyDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Address |
The address value. |
AddressDataContract |
None. |
| Keys |
The collection of keys. |
Collection of PropertyKeyDataContract |
None. |
| Alarms |
The collection of alarms. |
Collection of PropertyAlarmDataContract |
None. |
| Roles |
The collection of roles. |
Collection of RoleDataContract |
None. |
| InactiveRoleIds |
The unique identifiers of the related inactive role resources. |
Collection of integer |
None. |
| SpecialArrangements |
The collection of special arrangements. |
Collection of PropertySpecialArrangementDataContract |
None. |
| SystemStatusName |
The system status name value. |
string |
None. |
| Certificates |
The collection of certificates. |
Collection of PropertyCertificateDataContract |
None. |
| DefaultPicture |
The default picture value. |
DocumentDataContract |
None. |
| CustomFields |
The collection of custom fields. |
Collection of CustomFieldGroupWithValuesDataContract |
None. |
| RetentionAmount |
The retention amount value. |
decimal number |
None. |
| PreApprovedSpendAmount |
The pre approved spend amount value. |
decimal number |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.