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.
Get image from publication data for a real estate object
This endpoint retrieves a single published image for a real estate object.
The imageId is obtained from the images array returned by the Get publication data endpoint. Images are retrieved one at a time due to their size.
The object can be identified by its internal reference, its external identifier, or both.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Conditional | Internal identifier of the object. Either reference or externalIdentifier must be provided. If both are given, the object must match both values. |
externalIdentifier | string | Conditional | External identifier of the object, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the object must match both values. |
imageId | integer (int64) | Yes | Internal identifier of the image to retrieve, as returned by the Get publication data endpoint. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
(response body) | string (byte) | Yes | The response body is the raw image data, not a JSON object with named fields. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
The requested image is not found. It may be removed, deleted or it does not belong to the Object