Estate images published on Homepage

Resource type: estatepictures

With this API call, information about the images published on the own website can be read out. These are all files of the file type “pictures” in an estate, which have the check mark “own homepage / API” set under “Publication / Veröffentlichung”. If you use the multi-language module, you can read the file title and the free text field of the file language-dependent.

Further information on the multi-language module is available here.

Parameters:

  • estateids
    ARRAY. MANDATORY. estate IDs
  • categories
    ARRAY. MANDATORY. Type of File (“Titelbild”, “Foto”, “Foto_gross”, “Grundriss”, “Lageplan”, “Epass_Skala”, “Panorama”)
  • size
    STRING. Image size in pixels in the format “500×500”
  • language
    STRING. OPTIONAL. Language in three capital letters according to ISO 3166-1 alpha-3. Only relevant when working with multilingual objects. For multilingual objects, file title and free text are output in the specified language. If this parameter is not specified, the file title and free text of the estate are output in the system language. If file titles and/or free text are not available in the specified language, the system language will also be output. For this parameter to work, the estateids of a main property must be specified.

  • extendedclaim
    STRING. Mandatory for marketplace providers. Not relevant for all other users. To verify the user which uses the marketplace return the “apiClaim” parameter from the service call as “extendedclaim”. User rights are then observed by the marketplace provider API user.

Response:

  • id
    File ID
  • estateid
    Estate ID
  • type
    Type of file
  • url
    URL
  • titel
    Title
  • text
    Image description
  • modified
    Date of last change as unix timestamp

Example with ID of a main property and specifying language:

...
    {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
        "identifier": "",
        "resourcetype": "estatepictures",
        "resourceid": "",
        "parameters":
        {
            "estateids": [137],
            "categories": ["Foto"],
            "language":"ENG"
        }
    }
...

Response Example with ID of a main property and specifying language:

...
"records": [
	{
		"id": 1461,
		"type": "files",
		"elements": 
		{
			"estateid": "137",
			"type": "Foto",
			"url": "https:\/\/image.onoffice.de\/smart25\/Objekte\/index.php?kunde=Igelmund&datensatz=137&filename=Foto_1461.jpg",
			"title": "Screenshot Englisch ",
			"text": "Freitext Englisch OFF",
			"originalname": "Screenshot Shopping Center.png",
			"modified": 1540301235
		}
	}
]
...

Example with ID of a property in foreign language, without specification of language:

...
    {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
        "identifier": "",
        "resourcetype": "estatepictures",
        "resourceid": "",
        "parameters":
        {
            "estateids": [143],
            "categories": ["Foto"]
        }
    }
...

Response example with ID of a main property:

...
"records": [
	{
		"id": 1461,
		"type": "files",
		"elements":
		{
			"estateid": "137",
			"type": "Foto",
			"url": "https:\/\/image.onoffice.de\/smart25\/Objekte\/index.php?kunde=Igelmund&datensatz=137&filename=Foto_1461.jpg",
			"title": "Screenshot Deutsch",
			"text": "Freitext Deutsch OFF",
			"originalname": "Screenshot Shopping Center.png"
		}, 
		{
			"estateid": "143",
			"type": "Foto",
			"url": "https:\/\/image.onoffice.de\/smart25\/Objekte\/index.php?kunde=Igelmund&datensatz=137&filename=Foto_1461.jpg",
			"title": "Screenshot Englisch",
			"text": "Freitext Englisch OFF",
			"originalname": "Screenshot Shopping Center.png",
			"modified": 1540301235
		}
	}
]
...