Property and Facility Attributes

2min

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.
propertyOwnership
string
Value: self, rented, partner, client
location
VarChar
Physical mapping of the area to mark the property.
location>
houseNumber
string
Building number in which the apartment is.
location>
addressLine1
string
Address line 1.
location>
addressLine2 (optional)
string
Optional address line 2.
location>
addressLine3 (optional)
string
Optional address line 3.
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. Value: 
Code example - IN, 
Name example - India
geolocation
string
Location of property marked by its latitude & longitude.
geolocation>
latitude
string
Latitude of the Property.
geolocation>
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 (optional)
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. Or you can provide property details including: propertyname, propertycode, propertyownerID, area, propertyownership, location.
area
number
Area of the Facility.
operatingduration
string
Hours of operation of the Facility. (hh:mm:ss to hh:mm:ss)
operatingDays (optional)
array
Days of operation of the Facility. (days of the week/dates in a month)
startTime
string
Starting time of the facility.
endTime (optional)
string
End time of the facility.
teams (optional)
array
The array of team IDs the facility belongs to.
﻿

Updated 03 Aug 2023

Did this page help you?

Facility API

Creating Property and Facility

Docs powered by Archbee

TABLE OF CONTENTS

Property Attributes

Facility Attributes

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.
propertyOwnership	string	Value: self, rented, partner, client
location	VarChar	Physical mapping of the area to mark the property.
location> houseNumber	string	Building number in which the apartment is.
location> addressLine1	string	Address line 1.
location> addressLine2 (optional)	string	Optional address line 2.
location> addressLine3 (optional)	string	Optional address line 3.
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. Value: Code example - IN, Name example - India
geolocation	string	Location of property marked by its latitude & longitude.
geolocation> latitude	string	Latitude of the Property.
geolocation> longitude	string	Longitude of the Property.

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 (optional)	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. Or you can provide property details including: propertyname, propertycode, propertyownerID, area, propertyownership, location.
area	number	Area of the Facility.
operatingduration	string	Hours of operation of the Facility. (hh:mm:ss to hh:mm:ss)
operatingDays (optional)	array	Days of operation of the Facility. (days of the week/dates in a month)
startTime	string	Starting time of the facility.
endTime (optional)	string	End time of the facility.
teams (optional)	array	The array of team IDs the facility belongs to.