GET api/property/{id}
Get a property by its Id
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
PropertyDataContractName | Description | Type | Additional information |
---|---|---|---|
Address | AddressDataContract |
None. |
|
Keys | Collection of PropertyKeyDataContract |
None. |
|
Alarms | Collection of PropertyAlarmDataContract |
None. |
|
Roles | Collection of RoleDataContract |
None. |
|
InactiveRoleIds | Collection of integer |
None. |
|
SpecialArrangements | Collection of PropertySpecialArrangementDataContract |
None. |
|
SystemStatusName | string |
None. |
|
Certificates | Collection of PropertyCertificateDataContract |
None. |
|
DefaultPicture | DocumentDataContract |
None. |
|
CustomFields | Collection of CustomFieldGroupWithValuesDataContract |
None. |
|
RetentionAmount | decimal number |
None. |
|
PreApprovedSpendAmount | decimal number |
None. |
|
Id | integer |
None. |
Response Formats
application/json
Sample:
text/json
Sample: