Contents x
    Update a section
    • 07 Feb 2025
    • 5 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Update a section

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

    Put
    /api/v1/realestateobjects/sections

    [PREVIEW] Update an existing section.

    Description

    Update an existing section. This will fully overwrite the section with the data from the request. Both the 'reference' and the 'externalIdentifier' can be used to identify the section which needs to be overwritten. Preferably only the reference is used. If this is not available, the externalIdentifier can be used. If both properties are used it is important that both are correct and match with the same entity (section). If this is not the case, the request will return with an error code and the section will not be overwritten. 

    A section refers to sections of a building. Example: A complex containing a building with a shop on the ground floor and three apartments above it. This is a combination of commercial real estate and residential living. It is crucial to set this up correctly as it forms the foundation of the object structure in Bloxs: proper cost allocation, reporting purposes, assignment of a 'concierge,' and creation of (service) notifications.

    Use Case

    The Bloxs user has added a section with multiple incorrect properties. Therefore the user wants to change multiple properties at the same time rather than making several requests and changing one property at a time.

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

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

    extraRelations

    Via 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.).
    underManagementSinceFrom 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.
    complexReference

    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.

    addressThe address of the object. Please note: A change in the address of a section 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 object.
    housenumberHousenumber of the unit. This field could also be used to enter the room number.
    postalCodeThe postal code of the object.
    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.

    Response fields

    The response contains the fields in the table below. 

    FieldDescription
    displayNameA combination of the 'address' & the 'name' of the object.
    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).
    totalRawFloorArea

    Gross Floor Area.

    The total measured floor area of all rentable units contained in the complex according to the NEN2580 standards. Decimals are separated with a period (.).

    totalRentableFloorArea

    Rentable Floor Area.

    Rentable floor area of all rentable units contained in the complex according to the NEN2580 standards. Decimals are separated with a period (.)

    totalUsableFloorArea
    		The total actual usable floor area of all rentable units contained in the complex.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    Expand All
    object
    externalIdentifier
    string Required
    Min length0
    Max length100
    name
    string | null
    Min length0
    Max length256
    categoryName
    string Required
    Min length0
    Max length256
    extraRelations
    Array of object (RealEstateExtraRelationAPIModel) | null
    object
    extraRelationTypeName
    string | null
    relationReference
    string | null
    remarks
    string | null
    underManagementSince
    string (date) | null
    complexReference
    string Required
    Min length0
    Max length100
    address
    object (Address) Required
    street
    string Required
    Min length0
    Max length200
    houseNumber
    string | null
    Min length0
    Max length40
    postalCode
    string Required
    Min length0
    Max length20
    city
    string Required
    Min length0
    Max length200
    countryISOCode
    string Required
    Min length0
    Max length2
    reference
    string | null
    Min length0
    Max length100
    Responses
    200

    The section was updated

    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
    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
    totalRawFloorArea
    number (double) | null
    totalRentableFloorArea
    number (double) | null
    totalUsableFloorArea
    number (double) | null
    400

    The section data has validation issues

    Expand All
    object
    type
    string | null
    title
    string | null
    traceId
    string | null
    status
    integer (int32)
    errors
    object | null
    property*
    Array of string | null additionalProperties
    string
    What's Next