Contents x
    Get a unit
    • 07 Feb 2025
    • 6 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get a unit

    • Updated on 07 Feb 2025
    • 6 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/realestateobjects/units

    [PREVIEW] Get an existing unit. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the unit.

    Description

    Retrieve the information currently known in the Bloxs database about a certain unit. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference.

    A unit can be included in a rental contract. It is part of a larger entity, consisting of multiple units that can also be rented. Examples include a room in a student house or an apartment in a townhouse in Amsterdam. A unit always belongs to a complex, and optionally to a building section. A unit is either part of a complex or part of a building section; it cannot be part of both.

    Use Case

    Through this operation the user can display a specific unit and the related information. For example the user wants to display all the information of the unit to see which data points need to be adjusted. This endpoint can also be used to retrieve the reference, in case the value is not known to the user.

    Request fields

    The request contains the following fields:

    FieldDescription
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all objects. The relationship number is generated by the Bloxs system.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.

    Response fields

    The response contains the fields in the table below. For the get operation it gives a up-to-date insight in the data that is currently registered in Bloxs.

    FieldDescription
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all objects. The relationship number is generated by the Bloxs system.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    nameThe custom name assigned to the object. This is used for reporting and to distinguish the object when the address alone is insufficient. In the case of room rentals, this would be the address + room number. This name can also be displayed on invoices and bills.
    displayNameCombination of the 'address' & the 'name' of the object.
    ownerReferenceProperty owner. This field is used to link the property to its owner.  It is part of the contracts triangle of properties, owners, and tenants. The OwnerReference corresponds to the 'Reference' in the Relations. API. This unique ID is generated by the Bloxs portal and should not be confused with the external identifier. A property can have only one owner.
    categoryNameThe name of the category. The category describes what type of object it concerns and gives an indication of what the purpose of the building is. Examples are: House, office or shop. The enumeration can be set by the user in the admin module. In the administration, there is already a default list created by Bloxs, which can be modified by the user. In order to retrieve the available list of categories, the following GET can be used: Get a list of categories
    extraRelationsVia this field any existing relation (Person, organisation, supplier, Owner or Estate Agent) can be linked to this object. For example,  if a certain person is responsible for the maintenance, this field can be used to link this person to the object. Note that only existing relations can be linked. New relations should be entered through the relations-api insert operations. If the user does not know the detailed information of the relation that should be linked, one of the GET operations from the relations API should be used. The owner of the property should be added through the field 'ownerReference'. The estate agent of the property should be added through the field 'EstateAgentReference'. All other relations that should be linked can be entered through extraRelations.
    extraRelations.extraRelationTypeName
    		The relation type of the existing relation that should be linked to this object. This is a separate field from the 'RelationTypeName' in the relations-api. The extraRelationTypeName refers to the relation type specifically assigned to the this object. For example, a person has the relationTypeName 'maintenance' assigned. However,  for this specific object the person performs the role of 'cleaner' rather than maintenance. Through the field extraRelationTypeName the role of cleaner can be assigned. The enumeration can be set by the user in the admin module. In the administration, there is already a default list created by Bloxs, which can be modified by the user. In order to retrieve the available list of relation types, the following GET can be used: GET extraRelationTypes.
    extraRelations.relationReferenceThe reference of the existing relation that should be linked to this object. The reference should be identical to the reference such as registered in the Bloxs application.
    remarksComments for free text. Anything that cannot be entered in the other fields can be entered here. It is important not to enter sensitive information here (passwords, personal data, etc.).
    underMangementSinceFrom this date, the user has become the manager of the object. The date is initially entered and remains unchanged until the sale/termination of management.
    salesDate

    This is the date on which the object was sold or is no longer under management. Entering this date will result in the object being archived, and it will no longer be selectable in lists, etc.

    This date cannot be filled in if the object still has active contracts.

    lastModifiedTimestamp of the last modification within Bloxs (determined by Bloxs).
    complexReference

    Complex  associated with the property

    This field links the property to a complex. It must be a complex which has been previously added either through the Bloxs application or via the API. The complexReference corresponds to the 'Reference' previously assigned to the complex. This unique ID is generated by the Bloxs application and should not be confused with the external identifier. A property can only be part of one complex.

    sectionReference

    Section  associated with the property

    This field links the property to a section. It must be a section which has been previously added either through the Bloxs application or via the API. The sectionReference corresponds to the 'Reference' previously assigned to the section. This unique ID is generated by the Bloxs application and should not be confused with the external identifier. A property can only be part of one section.

    addressThe address of the unit. Please note: A change in the address of a unit will not automatically update the address of the associated complex or building. If the address of the associated complex or building also changes, this change must be submitted separately via the relevant API.
    streetThe street of the unit.
    housenumberHousenumber of the unit. This field could also be used to enter the room number.
    postalCodePostal code of the unit.
    cityThe place (city/town) in which the unit is situated.
    countryISOCodeISO country code. Use the 2-letter code from the ISO 639-1 Code list.

    rawFloorArea

    Gross Floor Area

    The total measured floor area according to the NEN2580 standards. Decimals are separated with a period (.).

    rentableFloorArea

    Rentable Floor Area

    Rentable floor area according to the NEN2580 standards. Decimals are separated with a period (.).

    usableFloorAreaThe surface of the floor that can actually be used.
    energyIndexA representation of the energy rerformance of the property. More accurate than an energy label. Defined as a numerical value.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    reference
    string

    The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

    externalIdentifier
    string

    The external API identifier of the model.

    Responses
    200

    OK

    Expand All
    object
    reference
    string | null
    externalIdentifier
    string | null
    name
    string | null
    displayName
    string | null
    ownerReference
    string | null
    categoryName
    string | null
    extraRelations
    Array of object (RealEstateExtraRelationAPIModel) | null
    object
    extraRelationTypeName
    string | null
    relationReference
    string | null
    remarks
    string | null
    underManagementSince
    string (date-time) | null
    salesDate
    string (date-time) | null
    lastModified
    string (date-time)
    complexReference
    string | null
    sectionReference
    string | null
    address
    object (Address)
    street
    string
    Min length0
    Max length200
    houseNumber
    string | null
    Min length0
    Max length40
    postalCode
    string
    Min length0
    Max length20
    city
    string
    Min length0
    Max length200
    countryISOCode
    string
    Min length0
    Max length2
    rawFloorArea
    number (double) | null
    rentableFloorArea
    number (double) | null
    usableFloorArea
    number (double) | null
    energyIndex
    number (double) | null
    404

    The requested unit was not found.

    What's Next