Property and Facility Attributes
Attributes are the specifications that determine the actions or tasks a Property or a Facility can perform. The Facility APIs provide a standard set of system-defined Attributes for a Property and a Facility.
Property Attributes
The following list describes the predefined Property Attributes that are unique to defining a physical location:
Attribute | Data type | Descriptions |
---|---|---|
propertyName | string | Name of the participant Property. Character length: 1-64. |
propertyCode | string | Any unique associated with the participant Property being created. Character length 1-64. |
propertyOwnerId | string | The participant ID of the participant type as specified in allowedOwners during the creation of the said type. Character length: 1-64. |
area | number | Area of the Property. |
buildingNumber | string | Building number in which the apartment is. |
addressLine1 | string | Address line 1. |
addressLine2 (optional) | string | Optional address line 2. |
addressLine3 (optional) | string | Optional address line 3. |
apartmentNumber (optional) | string | Apartment number. |
floor (optional) | string | Floor on which the apartment is. |
city | string | City of the Property. |
state | string | State of the Property. |
zipCode | string | Zip code of the Property. |
country | object | Country of the Property. |
latitude | string | Latitude of the Property. |
longitude | string | Longitude of the Property. |
Facility Attributes
The following list describes the predefined Facility Attributes that are unique to defining an operating entity:
Attribute | Data type | Description |
---|---|---|
facilityName | string | Name of the participant Facility. Character length: 1-64. |
facilityCode | string | Any unique ID associated with the participant Facility being created. Character length: 1-64. |
facilityOwnerId | string | The participant ID of the participant type as specified in allowedOwners during the creation of the said type. Character length: 1-64. |
facilityType | string | Type of Facility. |
propertyId | string | ID if the Property to which this Facility belongs. |
area | number | Area of the Facility. |
operatingHours (optional) | string | Hours of operation of the Facility. (hh:mm:ss to hh:mm:ss) |
operatingDays (optional) | string | Days of operation of the Facility. (days of the week/dates in a month) |
numberOfDock (optional) | string | Number of docks in a Facility. |
Updated 4 months ago