Property Structure / Tenants / Devices

Modified on Mon, 22 Apr at 11:30 AM

Property Structure


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


TermDescriptionFrNl
PropertyBuilding or group of building (usually having a common boiler ) for which ista is performing billing.Co-PropriétéGebouw (Mede-eigendom)
EntranceA property can have one or more entrances.

Immeuble,  EntréeIngang
Consumption Unit
(Abbreviation: ConsUnit)
Each entrance can have one or more consunit.

Unité de consommation
(Appartement)
Verbruikseenheid (appartement)
DwellingsSame as consunit but excluding common spaces and boiler roomAppartement Appartement
AdministratorThe company (usually a Syndic) who is administrating the Entrance for the CoOwnerAssociationGérantBeheerder 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:



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




Here is the list of endpoints

EndPointHttp
Verb
Description
/PropertiesGETRetrieve all properties the provided list of administrators (istaAdministratorIds) is allowed to access.
/Property/<PropertyUUId>GETRetrieve a particular property
/Property/<PropertyUUId>/EntrancesGETRetrieve entrances for a particular property
/Property/<PropertyUUId>/Entrances/<EntranceUUId>/ConsUnitsGETRetrieve consunits for a particular entrance
/Property/<PropertyUUId>/Entrances/<EntranceUUId>/ConsUnits/<ConsUnitUUId>
GETRetrieve a specific consunit
(Added: 22-04-2024)





Tenant


EndPointHttp VerbDescription
/Property/<PropertyUUId>/Tenants
[?includeHistory=false]
GETRetrieves tenants for a particular property.
Use includeHistory=true to also get tenants who moved out in the past


Devices


EndPointHttp VerbDescription
/Property/<PropertyUUId>/Devices
[?includeHistory=false]
GETRetrieves devices for a particular property.
Use IncludeHistory=true to also retrieve inactive devices (removed or replaced)


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article