Expose API

Attachment

The resource attachment represents the attachments (picture, document, video, link, video stream) of the expose. The attachment holds meta information and an URI to the specific data (e. g. the location of the image data).

https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/{expose_id}/attachment/{attachment_id}

 

Note: The list representation retrieves not only reference entries (xlink) but also the full meta data of each attachment (this differs from a strict RESTful view). If you only need information for a specific attachment you should provide an attachment id. An attachment represents only descriptive meta information and not the content itself (e. g. the image data or the PDF document).

 

 

Supported methods

Attachment/Get

Supported media types

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

 

Authorization requirements

At least a System Key is required for this operation. See Authentication via Two-legged OAuth for further details.

 

Request

 

Path Parameters

expose_id

The Id of an expose to get attachments for.

attachment_id

The Id of an attachment of an expose.

 

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

No special headers.

 

Body

 

XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:attachment xmlns:shortlist="http://rest.immobilienscout24.de/schema/search/shortlist/1.0" 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:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="common:Picture" xlink:href="https://rest.sandbox-immobilienscout24.de/restapi/api/search/v1.0/expose/64848329/attachment/1" id="1" modification="2016-03-04T14:17:01.081Z" creation="2016-03-04T14:17:01.081Z" publishDate="2016-03-04T14:17:01.081Z">
    <title>NNBxEIg</title>
    <floorplan>false</floorplan>
    <titlePicture>true</titlePicture>
    <urls>
        <url scale="SCALE_60x60" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/60x60%3E/extent/60x60/format/jpg"/>
        <url scale="SCALE_118x118" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/118x118%3E/extent/118x118/format/jpg"/>
        <url scale="SCALE_210x210" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/210x210%3E/format/jpg"/>
        <url scale="SCALE_540x540" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/540x540%3E/format/jpg"/>
        <url scale="SCALE" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/%WIDTH%x%HEIGHT%%3E/format/jpg"/>
        <url scale="SCALE_AND_CROP" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/legacy_thumbnail/%WIDTH%x%HEIGHT%/format/jpg"/>
        <url scale="WHITE_FILLING" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/%WIDTH%x%HEIGHT%%3E/extent/%WIDTH%x%HEIGHT%/format/jpg"/>
    </urls>
</common:attachment>
JSON
{
  "common.attachment":{
    "@xsi.type":"common:Picture",
    "@xlink.href":"https:\/\/rest.sandbox-immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/64848329\/attachment\/1",
    "@id":"1",
    "@modification":"2016-03-04T14:17:01.081Z",
    "@creation":"2016-03-04T14:17:01.081Z",
    "@publishDate":"2016-03-04T14:17:01.081Z",
    "title":"NNBxEIg",
    "floorplan":"false",
    "titlePicture":"true",
    "urls":[
      {
        "url":[
          {
            "@scale":"SCALE_60x60",
            "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/60x60%3E\/extent\/60x60\/format\/jpg"
          },
          {
            "@scale":"SCALE_118x118",
            "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/118x118%3E\/extent\/118x118\/format\/jpg"
          },
          {
            "@scale":"SCALE_210x210",
            "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/210x210%3E\/format\/jpg"
          },
          {
            "@scale":"SCALE_540x540",
            "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/540x540%3E\/format\/jpg"
          },
          {
            "@scale":"SCALE",
            "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/%WIDTH%x%HEIGHT%%3E\/format\/jpg"
          },
          {
            "@scale":"SCALE_AND_CROP",
            "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/legacy_thumbnail\/%WIDTH%x%HEIGHT%\/format\/jpg"
          },
          {
            "@scale":"WHITE_FILLING",
            "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/%WIDTH%x%HEIGHT%%3E\/extent\/%WIDTH%x%HEIGHT%\/format\/jpg"
          }
        ]
      }
    ]
  }
}

 

 

Attachment/GetList

Returns a list of resources identified by the following URL.

 

Note: This resource varies from a strict RESTful view; the list contains not only references to unique attachments (using xlink) but also the full flattened data of the specific attachment.

 

 

Supported media types

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

 

Authorization requirements

At least a System Key is required for this operation. See Authentication via Two-legged OAuth for further details.

 

Request

Path Parameters

expose_id

The Id of an expose to get attachments for.

 

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

No special headers.

 

Body

 

 

XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:attachments xmlns:shortlist="http://rest.immobilienscout24.de/schema/search/shortlist/1.0" 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:xlink="http://www.w3.org/1999/xlink">
    <attachment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="common:Picture" xlink:href="https://rest.sandbox-immobilienscout24.de/restapi/api/search/v1.0/expose/64848329/attachment/1" id="1" modification="2016-03-04T14:17:01.081Z" creation="2016-03-04T14:17:01.081Z" publishDate="2016-03-04T14:17:01.081Z">
        <title>NNBxEIg</title>
        <floorplan>false</floorplan>
        <titlePicture>true</titlePicture>
        <urls>
            <url scale="SCALE_60x60" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/60x60%3E/extent/60x60/format/jpg"/>
            <url scale="SCALE_118x118" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/118x118%3E/extent/118x118/format/jpg"/>
            <url scale="SCALE_210x210" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/210x210%3E/format/jpg"/>
            <url scale="SCALE_540x540" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/540x540%3E/format/jpg"/>
            <url scale="SCALE" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/%WIDTH%x%HEIGHT%%3E/format/jpg"/>
            <url scale="SCALE_AND_CROP" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/legacy_thumbnail/%WIDTH%x%HEIGHT%/format/jpg"/>
            <url scale="WHITE_FILLING" href="https://spicture.preview-is24.de/pic/orig03/N/107/26/750/107026750-0.png/ORIG/resize/%WIDTH%x%HEIGHT%%3E/extent/%WIDTH%x%HEIGHT%/format/jpg"/>
        </urls>
    </attachment>
    <attachment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="common:Picture" xlink:href="https://rest.sandbox-immobilienscout24.de/restapi/api/search/v1.0/expose/64848329/attachment/2" id="2" modification="2016-03-04T14:17:01.081Z" creation="2016-03-04T14:17:01.081Z" publishDate="2016-03-04T14:17:01.081Z">
        <title>mOmjFam</title>
        <floorplan>false</floorplan>
        <titlePicture>false</titlePicture>
        <urls>
            <url scale="SCALE_60x60" href="https://spicture.preview-is24.de/pic/orig04/N/107/26/751/107026751-0.jpg/ORIG/resize/60x60%3E/extent/60x60/format/jpg"/>
            <url scale="SCALE_118x118" href="https://spicture.preview-is24.de/pic/orig04/N/107/26/751/107026751-0.jpg/ORIG/resize/118x118%3E/extent/118x118/format/jpg"/>
            <url scale="SCALE_210x210" href="https://spicture.preview-is24.de/pic/orig04/N/107/26/751/107026751-0.jpg/ORIG/resize/210x210%3E/format/jpg"/>
            <url scale="SCALE_540x540" href="https://spicture.preview-is24.de/pic/orig04/N/107/26/751/107026751-0.jpg/ORIG/resize/540x540%3E/format/jpg"/>
            <url scale="SCALE" href="https://spicture.preview-is24.de/pic/orig04/N/107/26/751/107026751-0.jpg/ORIG/resize/%WIDTH%x%HEIGHT%%3E/format/jpg"/>
            <url scale="SCALE_AND_CROP" href="https://spicture.preview-is24.de/pic/orig04/N/107/26/751/107026751-0.jpg/ORIG/legacy_thumbnail/%WIDTH%x%HEIGHT%/format/jpg"/>
            <url scale="WHITE_FILLING" href="https://spicture.preview-is24.de/pic/orig04/N/107/26/751/107026751-0.jpg/ORIG/resize/%WIDTH%x%HEIGHT%%3E/extent/%WIDTH%x%HEIGHT%/format/jpg"/>
        </urls>
    </attachment>
    <attachment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="common:Picture" xlink:href="https://rest.sandbox-immobilienscout24.de/restapi/api/search/v1.0/expose/64848329/attachment/3" id="3" modification="2016-03-04T14:17:01.081Z" creation="2016-03-04T14:17:01.081Z" publishDate="2016-03-04T14:17:01.081Z">
        <title>KfJbu8d</title>
        <floorplan>true</floorplan>
        <titlePicture>false</titlePicture>
        <urls>
            <url scale="SCALE_60x60" href="https://spicture.preview-is24.de/pic/orig01/N/107/26/752/107026752-0.jpg/ORIG/resize/60x60%3E/extent/60x60/format/jpg"/>
            <url scale="SCALE_118x118" href="https://spicture.preview-is24.de/pic/orig01/N/107/26/752/107026752-0.jpg/ORIG/resize/118x118%3E/extent/118x118/format/jpg"/>
            <url scale="SCALE_210x210" href="https://spicture.preview-is24.de/pic/orig01/N/107/26/752/107026752-0.jpg/ORIG/resize/210x210%3E/format/jpg"/>
            <url scale="SCALE_540x540" href="https://spicture.preview-is24.de/pic/orig01/N/107/26/752/107026752-0.jpg/ORIG/resize/540x540%3E/format/jpg"/>
            <url scale="SCALE_1000x1000" href="https://spicture.preview-is24.de/pic/orig01/N/107/26/752/107026752-0.jpg/ORIG/resize/1000x1000%3E/format/jpg"/>
            <url scale="SCALE" href="https://spicture.preview-is24.de/pic/orig01/N/107/26/752/107026752-0.jpg/ORIG/resize/%WIDTH%x%HEIGHT%%3E/format/jpg"/>
            <url scale="SCALE_AND_CROP" href="https://spicture.preview-is24.de/pic/orig01/N/107/26/752/107026752-0.jpg/ORIG/legacy_thumbnail/%WIDTH%x%HEIGHT%/format/jpg"/>
            <url scale="WHITE_FILLING" href="https://spicture.preview-is24.de/pic/orig01/N/107/26/752/107026752-0.jpg/ORIG/resize/%WIDTH%x%HEIGHT%%3E/extent/%WIDTH%x%HEIGHT%/format/jpg"/>
        </urls>
    </attachment>
    <attachment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="common:StreamingVideo" xlink:href="https://rest.sandbox-immobilienscout24.de/restapi/api/search/v1.0/expose/64848329/attachment/4" id="4">
        <title>Video</title>
        <videoId>1UZhIjemca_Scjw99mCBdw</videoId>
    </attachment>
</common:attachments>
JSON
{
  "common.attachments":[
    {
      "attachment":[
        {
          "@xsi.type":"common:Picture",
          "@xlink.href":"https:\/\/rest.sandbox-immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/64848329\/attachment\/1",
          "@id":"1",
          "@modification":"2016-03-04T14:17:01.081Z",
          "@creation":"2016-03-04T14:17:01.081Z",
          "@publishDate":"2016-03-04T14:17:01.081Z",
          "title":"NNBxEIg",
          "floorplan":"false",
          "titlePicture":"true",
          "urls":[
            {
              "url":[
                {
                  "@scale":"SCALE_60x60",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/60x60%3E\/extent\/60x60\/format\/jpg"
                },
                {
                  "@scale":"SCALE_118x118",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/118x118%3E\/extent\/118x118\/format\/jpg"
                },
                {
                  "@scale":"SCALE_210x210",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/210x210%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE_540x540",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/540x540%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/%WIDTH%x%HEIGHT%%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE_AND_CROP",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/legacy_thumbnail\/%WIDTH%x%HEIGHT%\/format\/jpg"
                },
                {
                  "@scale":"WHITE_FILLING",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig03\/N\/107\/26\/750\/107026750-0.png\/ORIG\/resize\/%WIDTH%x%HEIGHT%%3E\/extent\/%WIDTH%x%HEIGHT%\/format\/jpg"
                }
              ]
            }
          ]
          
        },
        {
          "@xsi.type":"common:Picture",
          "@xlink.href":"https:\/\/rest.sandbox-immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/64848329\/attachment\/2",
          "@id":"2",
          "@modification":"2016-03-04T14:17:01.081Z",
          "@creation":"2016-03-04T14:17:01.081Z",
          "@publishDate":"2016-03-04T14:17:01.081Z",
          "title":"mOmjFam",
          "floorplan":"false",
          "titlePicture":"false",
          "urls":[
            {
              "url":[
                {
                  "@scale":"SCALE_60x60",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig04\/N\/107\/26\/751\/107026751-0.jpg\/ORIG\/resize\/60x60%3E\/extent\/60x60\/format\/jpg"
                },
                {
                  "@scale":"SCALE_118x118",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig04\/N\/107\/26\/751\/107026751-0.jpg\/ORIG\/resize\/118x118%3E\/extent\/118x118\/format\/jpg"
                },
                {
                  "@scale":"SCALE_210x210",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig04\/N\/107\/26\/751\/107026751-0.jpg\/ORIG\/resize\/210x210%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE_540x540",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig04\/N\/107\/26\/751\/107026751-0.jpg\/ORIG\/resize\/540x540%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig04\/N\/107\/26\/751\/107026751-0.jpg\/ORIG\/resize\/%WIDTH%x%HEIGHT%%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE_AND_CROP",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig04\/N\/107\/26\/751\/107026751-0.jpg\/ORIG\/legacy_thumbnail\/%WIDTH%x%HEIGHT%\/format\/jpg"
                },
                {
                  "@scale":"WHITE_FILLING",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig04\/N\/107\/26\/751\/107026751-0.jpg\/ORIG\/resize\/%WIDTH%x%HEIGHT%%3E\/extent\/%WIDTH%x%HEIGHT%\/format\/jpg"
                }
              ]
            }
          ]
          
        },
        {
          "@xsi.type":"common:Picture",
          "@xlink.href":"https:\/\/rest.sandbox-immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/64848329\/attachment\/3",
          "@id":"3",
          "@modification":"2016-03-04T14:17:01.081Z",
          "@creation":"2016-03-04T14:17:01.081Z",
          "@publishDate":"2016-03-04T14:17:01.081Z",
          "title":"KfJbu8d",
          "floorplan":"true",
          "titlePicture":"false",
          "urls":[
            {
              "url":[
                {
                  "@scale":"SCALE_60x60",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig01\/N\/107\/26\/752\/107026752-0.jpg\/ORIG\/resize\/60x60%3E\/extent\/60x60\/format\/jpg"
                },
                {
                  "@scale":"SCALE_118x118",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig01\/N\/107\/26\/752\/107026752-0.jpg\/ORIG\/resize\/118x118%3E\/extent\/118x118\/format\/jpg"
                },
                {
                  "@scale":"SCALE_210x210",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig01\/N\/107\/26\/752\/107026752-0.jpg\/ORIG\/resize\/210x210%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE_540x540",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig01\/N\/107\/26\/752\/107026752-0.jpg\/ORIG\/resize\/540x540%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE_1000x1000",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig01\/N\/107\/26\/752\/107026752-0.jpg\/ORIG\/resize\/1000x1000%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig01\/N\/107\/26\/752\/107026752-0.jpg\/ORIG\/resize\/%WIDTH%x%HEIGHT%%3E\/format\/jpg"
                },
                {
                  "@scale":"SCALE_AND_CROP",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig01\/N\/107\/26\/752\/107026752-0.jpg\/ORIG\/legacy_thumbnail\/%WIDTH%x%HEIGHT%\/format\/jpg"
                },
                {
                  "@scale":"WHITE_FILLING",
                  "@href":"https:\/\/spicture.preview-is24.de\/pic\/orig01\/N\/107\/26\/752\/107026752-0.jpg\/ORIG\/resize\/%WIDTH%x%HEIGHT%%3E\/extent\/%WIDTH%x%HEIGHT%\/format\/jpg"
                }
              ]
            }
          ]
          
        },
        {
          "@xsi.type":"common:StreamingVideo",
          "@xlink.href":"https:\/\/rest.sandbox-immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/64848329\/attachment\/4",
          "@id":"4",
          "title":"Video",
          "videoId":"1UZhIjemca_Scjw99mCBdw"
        }
      ]
    }
  ]
}