Property Structure / Tenants / Devices

Modified on Mon, 15 Jan 2024 at 03:29 PM

Property Structure

The property structure represent the "static" part of a property
At ista we are using the following nomenclature

Term	Description	Fr	Nl
Property	Building or group of building (usually having a common boiler ) for which ista is performing billing.	Co-Propriété	Gebouw (Mede-eigendom)
Entrance	A property can have one or more entrances.	Immeuble, Entrée	Ingang
Consumption Unit (Abbreviation: ConsUnit)	Each entrance can have one or more consunit.	Unité de consommation (Appartement)	Verbruikseenheid (appartement)
Dwellings	Same as consunit but excluding common spaces and boiler room	Appartement	Appartement
Administrator	The company (usually a Syndic) who is administrating the Entrance for the CoOwnerAssociation	Gérant	Beheerder gebouw
Co-Owner Association (COA)		Association de CoPropriétaires (ACP)	Vereniging van mede-eigenaars (VME)

The base url for WebAPI is the following:

https://front.ista-webservices.be/api/v1 (ALPHA)

Swagger:

https://front.ista-webservices.be/index.html

The request header must contain the following rows:

Key	Value
Authorization	"Bearer "+<Token receive by authentication API> See Authentication
istaAdministratorIds	List of ista Administrators Id (separated by ";" ) receive during registration process See also Authentication

Here is the list of endpoints

EndPoint	Http Verb	Description
/Properties	GET	Retrieve all properties the provided list of administrators (istaAdministratorIds) is allowed to access.
/Property/<PropertyUUId>	GET	Retrieve a particular property
/Property/<PropertyUUId>/Entrances	GET	Retrieve entrances for a particular property
/Property/<PropertyUUId>/Entrances/<EntranceUUId>/ConsUnits	GET	Retrieve consunits for a particular entrance
	GET

EndPoint	Http Verb	Description
/Property/<PropertyUUId>/Tenants [?includeHistory=false]	GET	Retrieves tenants for a particular property. Use includeHistory=true to also get tenants who moved out in the past

EndPoint	Http Verb	Description
/Property/<PropertyUUId>/Devices [?includeHistory=false]	GET	Retrieves devices for a particular property. Use IncludeHistory=true to also retrieve inactive devices (removed or replaced)