- 07 Feb 2025
- 1 Minute to read
- Print
- DarkLight
Get a list of extra relation types
- Updated on 07 Feb 2025
- 1 Minute to read
- Print
- DarkLight
[PREVIEW] Get a list of existing extra relation types.
Description
An 'extra Relation Type' can be assigned while inserting a new RealEstateObject (property ' extraRelationTypeName'). However, in order to add the correct type name the Bloxs user needs to know which type names are available in the application. This endpoint can be used to retrieve the available type names. This is a standard list, however it can be edited by the user in the Bloxs application (it is not possible through the API).
The response provides the full list of available ExtraRelationTypes as an array.
Use Case
By using the Buildings/PUT operation the user wants to edit a building. For this the user wants to include an extra relation type name for one of the extra relations. However, the user does not know which options are available as a type name. Therefore, the user can use this endpoint to retrieve all available extra relation type names.
Please enter a valid token
OK