Get a list of extra relation types
  • 07 Feb 2025
  • 1 Minute to read
  • Dark
    Light

Get a list of extra relation types

  • Dark
    Light

Article summary

Get
/api/v1/realestateobjects/common/extrarelationtypes

[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.

Security
HTTP
Type Bearer

Please enter a valid token

Responses
200

OK

Array of string
string