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:

AttributeData typeDescriptions
propertyNamestringName of the participant Property. Character length: 1-64.
propertyCodestringAny unique associated with the participant Property being created. Character length 1-64.
propertyOwnerIdstringThe participant ID of the participant type as specified in allowedOwners during the creation of the said type. Character length: 1-64.
areanumberArea of the Property.
propertyOwnershipstringValue: self, rented, partner, client
locationVarCharPhysical mapping of the area to mark the property.
location>houseNumberstringBuilding number in which the apartment is.
location>addressLine1stringAddress line 1.
location>addressLine2 (optional)stringOptional address line 2.
location>addressLine3 (optional)stringOptional address line 3.
citystringCity of the Property.
statestringState of the Property.
zipCodestringZip code of the Property.
countryobjectCountry of the Property.
Value:
Code example - IN
Name example - India
geolocationstringLocation of property marked by its latitude & longitude.
geolocation>latitudestringLatitude of the Property.
geolocation>longitudestringLongitude of the Property.

Facility Attributes

The following list describes the predefined Facility Attributes that are unique to defining an operating entity:

AttributeData typeDescription
facilityNamestringName of the participant Facility. Character length: 1-64.
facilityCodestringAny unique ID associated with the participant Facility being created. Character length: 1-64.
facilityOwnerId
(optional)
stringThe participant ID of the participant type as specified in allowedOwners during the creation of the said type. Character length: 1-64.
facilityTypestringType of Facility.
propertyIdstringID if the Property to which this Facility belongs. Or you can provide property details including: propertyname, propertycode, propertyownerID, area, propertyownership, location.
areanumberArea of the Facility.
operatingdurationstringHours of operation of the Facility. (hh:mm:ss to hh:mm:ss)
operatingDays (optional)arrayDays of operation of the Facility. (days of the week/dates in a month)
startTimestringStarting time of the facility
endTime
(optional)
stringEnd time of facility
teams (optional)arrayThe array of team IDs the facility belongs to