> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get image from publication data for a real estate object
> 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.
## OpenAPI
````json GET /api/v1/realestateobjects/publish/object/image
{
"openapi": "3.0.4",
"info": {
"title": "RealEstateObjects V1",
"description": "Welcome to BETA version of the new RealEstateObjects API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Admin"
},
{
"name": "Buildings"
},
{
"name": "Complexes"
},
{
"name": "Generic"
},
{
"name": "Metadata"
},
{
"name": "PublishObjects"
},
{
"name": "ScoringPointTotals"
},
{
"name": "Sections"
},
{
"name": "Units"
}
],
"paths": {
"/api/v1/realestateobjects/publish/object/image": {
"get": {
"tags": [
"Publish"
],
"summary": "Get image from publication data for a real estate object",
"description": "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.",
"operationId": "GetPublicationDataImage",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
"schema": {
"type": "string"
}
},
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"schema": {
"type": "string"
}
},
{
"name": "imageId",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
},
"404": {
"description": "The requested image is not found. It may be removed, deleted or it does not belong to the Object"
}
},
"x-d360-narrative-url": "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. |