Contents x
    Get image from publication data for a real estate object
    • 06 Jun 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Get image from publication data for a real estate object

    • Updated on 06 Jun 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/realestateobjects/publish/object/image

    Get image from publication data for an existing real estate object. ImageId must have a value. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the image.

    Description

    Retrieve a specific picture belonging to a published real estate object. The imageId can be retrieved by using endpoint PublicationData/GET endpoint. Pictures need to retrieved one-by-one because of the size. This endpoint will return the actual picture.

    Both the 'reference' and the 'externalIdentifier' can be used to identify the object 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 (object). If this is not the case, the request will return with an error code and the published data will not be overwritten.

    Use Case

    The Bloxs user wants to see the actual pictures which are currently published for a specific real estate objects.

    Request fields

    The request contains the following fields:

    FieldDescription
    referenceThe reference of the real estate object from which the published data needs to be retrieved. This reference is generated by Bloxs.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    imageIdThe unique identifier of the image. This ID is generated by Bloxs.


    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.

    imageId
    integer (int64)
    Responses
    200

    OK

    string (byte)
    404

    The requested image is not found. It may be removed, deleted or it does not belong to the Object

    What's Next