Attachment

Attachment/GETbyID

This method hands out the attachment by attachment ID.

https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username}/realestate/{id}/attachment/{id}

 

  • Example: GET https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/999999/realestate/58850320/attachment/123456 hands out the attachment to the real estate object 58850320 with the attachment ID=123456.
  • You can work with ATTACHMENT with your own object id as identifier for the realestate object by adding the prefix "ext-": https://... realestate/ext-{your object id}/attachment/{id}/....
  • You can do a GET ATTACHMENT with your own attachment id: http://rest.../realestate/{IS24-object-ID or your object ID/attachment?externalId={your attachment ID}. Already available on sandbox, from 19.3 on production, too.

Supported media types

  • XML (Accept: application/xml)
  • JSON (Accept: application/json)

Authorization requirements

A System Key and an authenticated user are required for this operation:

 

Please use a secure connection (https) for this operation.

Request

Path Parameters

  • Username. "me" can be used instead of the username.
  • realestateid: the unique real estate object id, which is generated automatically.
  • attachmentid: the attachment ID.

Query Parameters

none

Response

The following section includes the HTTP status code, a short description and examples for the response body content of a successful processed request.
Error responses as well as other simple message responses are described in detail within the common message responses.

 

Status 200 OK

The requested operation was successful.

Header

none

Body

XML

Example for a picture

Tip: you'll get the original picture by deleting everything behind "ORIG" in the picture url from the response.
Example: http://picture.immobilienscout24.de/pic/orig02/N/211/828/677/211828677-0.jpg/ORIG

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:attachment xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xmlns:ns5="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="common:Picture" ns5:href="https://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestate/63204710/attachment/665089044" id="665089044">   
  <title>shutterstock_87697798</title>

    <externalId>kitchen2</externalId>

    <externalCheckSum>checksum</externalCheckSum> 

    <floorplan>false</floorplan>
  <titlePicture>true</titlePicture>
  <urls>
    <url scale="SCALE" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/resize/%WIDTH%x%HEIGHT%%3E/format/jpg?1482192923"/>
    <url scale="SCALE_AND_CROP" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/legacy_thumbnail/%WIDTH%x%HEIGHT%/format/jpg?1482192923"/>
    <url scale="WHITE_FILLING" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/resize/%WIDTH%x%HEIGHT%%3E/extent/%WIDTH%x%HEIGHT%/format/jpg?1482192923"/>
    <url scale="SCALE_540x540" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/resize/540x540%3E/format/jpg?1482192923"/>
    <url scale="SCALE_210x210" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/resize/210x210%3E/format/jpg?1482192923"/>
    <url scale="SCALE_400x300" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/resize/400x300%3E/format/jpg?1482192923"/>
    <url scale="SCALE_118x118" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/resize/118x118%3E/extent/118x118/format/jpg?1482192923"/>
  <url scale="SCALE_60x60" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/resize/60x60%3E/extent/60x60/format/jpg?1482192923"/>
    <url scale="SCALE_73x73" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/legacy_thumbnail/73x73/format/jpg?1482192923"/>
    <url scale="SCALE_1000x1000" href="https://spicture.preview-is24.de/pic/orig02/N/104/749/277/104749277-0.jpg/ORIG/resize/1000x1000%3E/format/jpg?1482192923"/>
  </urls>
</common:attachment>

 

 

Example for a PDF


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:attachment xsi:type="common:PDFDocument" creation="2012-06-13T13:08:30.586+02:00" modification="2012-06-13T13:08:30.586+02:00" id="695672073" xlink:href="http://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/999999/realestate/65054604/attachment/695672073/695672073" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:ns4="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <title>title</title>

    <externalId>kitchen2</externalId>

    <externalCheckSum>checksum</externalCheckSum>       <url>http://rest.immobilienscout24.de/files/video001/N/135/965/292/135965292-0.pdf?1678716452</url>
   <floorplan>false</floorplan>
</common:attachment>

 

Example for a video

 

<?xml version="1.0" encoding="UTF-8" ?>
    <common.attachment>
        <@xsi.type>common:StreamingVideo</@xsi.type>
        <@id>677999672</@id>
        <title>Video</title>


        <externalId>kitchen2</externalId>

        <externalCheckSum>checksum</externalCheckSum>         

        <videoId>YCgYnrdvxvaB0Y4YR3NHNg</videoId>
        <videoInfo>
            <videoUrlList>
                <format>h264_250+32</format>
                <url>https://csp-ssl.picsearch.com/content?format=h264_250%2B32&amp;auth=4DWqCVLPXcRHBWIExmTmupf2AJJdFsa4dDb0wuA7Btq0CNY__hZvEvK80RBvmYZxu6Gk0UcdMhg.3gp</url>
            </videoUrlList>
            <videoUrlList>
                <format>h264_600+64</format>
                <url>https://csp-ssl.picsearch.com/content?format=h264_600%2B64&amp;auth=4DWqCVLPXcRHBWIExmTmupf2AJJdFsa4dDb0wuA7Btq0CNY__hZvEvK80RBvmYZxu6Gk0UcdMhg.3gp</url>
            </videoUrlList>
            <videoUrlList>
                <format>MP4</format>
                <url>https://csp-ssl.picsearch.com/content?format=iphone&amp;auth=4DWqCVLPXcRHBWIExmTmupf2AJJdFsa4dDb0wuA7Btq0CNY__hZvEvK80RBvmYZxu6Gk0UcdMhg.mp4</url>
            </videoUrlList>
            <duration>9616</duration>
            <teaserUrl>http://csp.picsearch.com/img/Y/C/g/Y/image_YCgYnrdvxvaB0Y4YR3NHNg/3.jpg</teaserUrl>
            <processingProgress>100</processingProgress>
        </videoInfo>
    </common.attachment>
   

 

Example for a URL

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:attachments xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:ns4="http://rest.immobilienscout24.de/schema/platform/gis/1.0">
   <attachment xsi:type="common:Link" creation="2012-06-14T11:18:24.118+02:00" modification="2012-06-14T11:18:24.118+02:00" id="585953289" xlink:href="http://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/999999/realestate/65054160/attachment/585953289" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <title>link test</title>


      <externalId>kitchen2</externalId>

      <externalCheckSum>checksum</externalCheckSum>      

      <url>http://youtube</url>
   </attachment>
</common:attachments>

 

JSON

Example for a picture

 

{"common.attachment": {
   "@xsi.type": "common:Picture",
   "@publishDate": "2012-06-20T10:25:10.052+02:00",
   "@creation": "2012-06-20T10:25:10.052+02:00",
   "@modification": "2012-06-20T10:25:10.052+02:00",
   "@id": "695671599",
   "@xlink.href": "http://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/999999/realestate/65053939/attachment/695671599/695671599",
   "title": "title",

    "externalId":"bild mit checksum",

    "externalCheckSum":"123abc",

   "floorplan": "false",
   "titlePicture": "true",
   "urls": [{"url":    [
            {
         "@scale":"SCALE_540x540",
         "@href":"http:\/\/picture.immobilienscout24.de\/pic\/orig04\/N\/211\/828\/675\/211828675-0.jpg\/ORIG\/resize\/540x540%3E\/format\/jpg?1881056898",
         
      },
            {
         "@scale": "SCALE_210x210"         
         "@href":"http:\/\/picture.immobilienscout24.de\/pic\/orig04\/N\/211\/828\/675\/211828675-0.jpg\/ORIG\/resize\/210x210%3E\/format\/jpg?1881056898",
         
      },
            {
         "@scale": "SCALE_400x300"         
         "@href":"http:\/\/picture.immobilienscout24.de\/pic\/orig04\/N\/211\/828\/675\/211828675-0.jpg\/ORIG\/resize\/400x300%3E\/format\/jpg?1881056898",
         
      },
            {
         "@scale": "SCALE_118x118"         
         "@href":"http:\/\/picture.immobilienscout24.de\/pic\/orig04\/N\/211\/828\/675\/211828675-0.jpg\/ORIG\/resize\/118x118%3E\/extent\/118x118\/format\/jpg?1881056898",
         
      },
            {
         "@scale": "SCALE_60x60"         
         "@href":"http:\/\/picture.immobilienscout24.de\/pic\/orig04\/N\/211\/828\/675\/211828675-0.jpg\/ORIG\/resize\/60x60%3E\/extent\/60x60\/format\/jpg?1881056898",
         
      },
            {
         "@scale": "SCALE_73x73"         
         "@href":"http:\/\/picture.immobilienscout24.de\/pic\/orig04\/N\/211\/828\/675\/211828675-0.jpg\/ORIG\/legacy_thumbnail\/73x73\/format\/jpg?1881056898",
         
      }
   ]}]
}}

 

 

Example for a PDF


{"common.attachment": {
   "@xsi.type": "common:PDFDocument",
   "@publishDate": "2012-06-20T10:47:48.839+02:00",
   "@creation": "2012-06-20T10:47:48.839+02:00",
   "@modification": "2012-06-20T10:47:48.839+02:00",
   "@id": "695671612",
   "@xlink.href": "http://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/999999/realestate/65054180/attachment/695671612/695671612",
   "title": "documenttitle",

   "externalId":"bild mit checksum",

   "externalCheckSum":"123abc",   "url": "http://rest.immobilienscout24.de/files/video001/N/135/964/842/135964842-0.pdf?1678716452",
   "floorplan": "true"
}

Example for a video

 

{"common.attachment": {
    "@xsi.type": "common:StreamingVideo",
    "@id": "677999672",
    "title": "Video",

    "externalId":"bild mit checksum",

    "externalCheckSum":"123abc",   

    "videoId": "YCgYnrdvxvaB0Y4YR3NHNg",
    "videoInfo": {
      "videoUrlList": [
        {
          "format": "h264_250+32",
          "url": "https://csp-ssl.picsearch.com/content?format=h264_250%2B32&auth=4DWqCVLPXcRHBWIExmTmupf2AJJdFsa4dDb0wuA7Btq0CNY__hZvEvK80RBvmYZxu6Gk0UcdMhg.3gp"
        },
        {
          "format": "h264_600+64",
          "url": "https://csp-ssl.picsearch.com/content?format=h264_600%2B64&auth=4DWqCVLPXcRHBWIExmTmupf2AJJdFsa4dDb0wuA7Btq0CNY__hZvEvK80RBvmYZxu6Gk0UcdMhg.3gp"
        },
        {
          "format": "MP4",
          "url": "https://csp-ssl.picsearch.com/content?format=iphone&auth=4DWqCVLPXcRHBWIExmTmupf2AJJdFsa4dDb0wuA7Btq0CNY__hZvEvK80RBvmYZxu6Gk0UcdMhg.mp4"
        }
      ],
      "duration": 9616,
      "teaserUrl": "http://csp.picsearch.com/img/Y/C/g/Y/image_YCgYnrdvxvaB0Y4YR3NHNg/3.jpg",
      "processingProgress": 100
    }
  }}

 

 

Example for a URL

{"common.attachment": {
   "@xsi.type": "common:Link",
   "@publishDate": "2012-06-20T10:57:27.698+02:00",
   "@creation": "2012-06-20T10:57:27.698+02:00",
   "@modification": "2012-06-20T10:57:27.698+02:00",
   "@id": "585954475",
   "@xlink.href": "http://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/999999/realestate/65054206/attachment/585954475/585954475",
   "title": "urltitle",

    "externalId":"bild mit checksum",

    "externalCheckSum":"123abc",

   "url": "http://test.de/abc"
}}