Contents x
    Get all available property definitions
    • 03 Jan 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get all available property definitions

    • Updated on 03 Jan 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/realestateobjects/publish/propertydefinitions

    Get all the configured property definitions objects from the system

    Description

    The Bloxs user has the possibility to create custom properties which are shown in the published data in the third party system (e.g.  rental website). An example would be if the user wants to add to the published data the property 'sunny hours per day'. This is standard not available in Bloxs. To include this in the published data, a custom published property needs to be inserted. This endpoint can be used to retrieve all custom published properties known in the environment specific to this client.

    The available property definitions are shown as an array in the response.

    Use Case

    The Bloxs user wants to know which custom properties are currently being published for the real estate objects. Calling this endpoint will return a full list of these properties.

    The Bloxs user wants to delete a specific custom property. However, in order to do this the user needs the apiLabel of this property. The user can utilize this endpoint to retrieve the properties and details, such as the apiLabel.

    Response fields

    The response contains the fields in the table below. For every property definition these properties will be shown separately in the array.

    FieldDescription
    apiLabelThe unique identifier of the custom property.
    labelNameThe name which has been assigned to the custom property.
    controlTypeThe control type of the custom property. For example, it can only contain numbers or it is a date field.
    orderOrder in which the fields are displayed within the screen in Bloxs. This can also help arrange the fields in the correct order on your website.
    options.valueWhen the ControlType is Dropdown, then these are the configured options for the dropdown. Value contains the name of the option in the dropdown.
    options.orderWhen the ControlType is Dropdown, then these are the configured options for the dropdown. Order contains the order in which the option is shown in the dropdown.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Responses
    200

    OK

    Array of object
    object
    apiLabel
    string

    The API Key of the property, this is the key used to identify the Object property

    Min length1
    labelName
    string

    The name of the property

    Min length1
    controlType
    integer (int32)

    0 = TextBox

    1 = NumberBox

    2 = DateBox

    3 = Dropdown

    4 = RichText

    5 = AmountBox

    6 = SquareMeterBox

    7 = MultiSelectDropdown

    Valid values[ \0\, \1\, \2\, \3\, \4\, \5\, \6\, \7\ ]
    order
    integer (int32)
    options
    Array of object (Publish_PropertyDefinitionOption) | null

    When the ControlType is Dropdown, then these are the configured options for the Dropdown

    object
    value
    string
    Min length1
    order
    integer (int32)
    What's Next