Retrieve Attachment of Real Estate project

This method retrieves an attachment's data previously assigned to a real estate project

GET /offer/v1.0/user/{username}/realestateproject/{realestateprojectid}/attachment/{attachmentId}

Supported media types:

XML

JSON

Note

Attachments types supported: Pictures, PDFDocuments, Links.
Picture types supported: COMPANY_LOGO, PROJECT_LOGO, IMAGE.
PDFDocument types supported: BROCHURE.
Link types supported: VIRTUAL_TOUR.

Request

Path Parameters

PARAMETER	DESCRIPTION
username	the username which the user uses for logging in to www.immobilienscout24.de "me" can be used instead of the username, when the user is logged in by 3-legged OAuth 1.0
realestateprojectid	the unique project ID, generated by IS24 when posting a real estate project
attachmentId	the ID of the attachment, generated by IS24 when assigning link to real estate project or requesting upload ticket for picture and pdf document

Successful response

HTTP Code: 200

XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:attachment xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
                xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0"
                xmlns:ns4="http://rest.immobilienscout24.de/schema/offer/realestateproject/1.0"
                xmlns:ns5="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xsi:type="ns4:Picture" id="1570d590-0a54-4b61-9dd6-7672795f6a7c">
  <pictureType>IMAGE</pictureType>
  <title>comment7Whg80NQ57I3dwxs4buP4</title>
  <urls>
    <url scale="SCALE"
         href="https://pictures.immobilienscout24.de/dims3/S3/resize/%WIDTH%x%HEIGHT%%3E/http://s3-eu-west-1.amazonaws.com/bucket-name/12345/d5fd3c60-5da4-4a4d-b482-607ae54fe7ed.jpg"/>
    <url scale="SCALE_AND_CROP"
         href="https://pictures.immobilienscout24.de/dims3/S3/legacy_thumbnail/%WIDTH%x%HEIGHT%/format/jpg/http://s3-eu-west-1.amazonaws.com/bucket-name/12345/d5fd3c60-5da4-4a4d-b482-607ae54fe7ed.jpg"/>
    <url scale="WHITE_FILLING"
         href="https://pictures.immobilienscout24.de/dims3/S3/resize/%WIDTH%x%HEIGHT%%3E/extent/%WIDTH%x%HEIGHT%/format/jpg/http://s3-eu-west-1.amazonaws.com/bucket-name/12345/d5fd3c60-5da4-4a4d-b482-607ae54fe7ed.jpg"/>
  </urls>
</ns4:attachment>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:attachment xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
                xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0"
                xmlns:ns4="http://rest.immobilienscout24.de/schema/offer/realestateproject/1.0"
                xmlns:ns5="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xsi:type="ns4:PDFDocument" id="e3005d38-5c8e-44b2-bf0c-c8d0c9f710d6">
  <url>
    http://s3-eu-west-1.amazonaws.com/bucket-name/12345/5b6981e1-eefe-48e7-9580-31b0987787e7.pdf
  </url>
  <pdfDocumentType>BROCHURE</pdfDocumentType>
</ns4:attachment>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:attachment xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
                xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0"
                xmlns:ns4="http://rest.immobilienscout24.de/schema/offer/realestateproject/1.0"
                xmlns:ns5="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xsi:type="ns4:Link" id="969e82fb-6582-4399-a962-7023b8714b97">
  <url>https://virtualtours.immobilienscout24.de/portal/tour/1234</url>
  <linkType>VIRTUAL_TOUR</linkType>
</ns4:attachment>

JSON:

{
  "realestateproject.attachment": {
    "@xsi.type": "ns2:Picture",
    "@id": "1570d590-0a54-4b61-9dd6-7672795f6a7c",
    "pictureType": "IMAGE",
    "title": "comment7Whg80NQ57I3dwxs4buP4",
    "urls": [
      {
        "url": [
          {
            "@scale": "SCALE",
            "@href": "https:\/\/pictures.immobilienscout24.de\/dims3\/S3\/resize\/%WIDTH%x%HEIGHT%%3E\/http:\/\/s3-eu-west-1.amazonaws.com\/bucket-name\/12345\/d5fd3c60-5da4-4a4d-b482-607ae54fe7ed.jpg"
          },
          {
            "@scale": "SCALE_AND_CROP",
            "@href": "https:\/\/pictures.immobilienscout24.de\/dims3\/S3\/legacy_thumbnail\/%WIDTH%x%HEIGHT%\/format\/jpg\/http:\/\/s3-eu-west-1.amazonaws.com\/bucket-name\/12345\/d5fd3c60-5da4-4a4d-b482-607ae54fe7ed.jpg"
          },
          {
            "@scale": "WHITE_FILLING",
            "@href": "https:\/\/pictures.immobilienscout24.de\/dims3\/S3\/resize\/%WIDTH%x%HEIGHT%%3E\/extent\/%WIDTH%x%HEIGHT%\/format\/jpg\/http:\/\/s3-eu-west-1.amazonaws.com\/bucket-name\/12345\/d5fd3c60-5da4-4a4d-b482-607ae54fe7ed.jpg"
          }
        ]
      }
    ]
  }
}

{
  "realestateproject.attachment": {
    "@xsi.type": "ns2:PDFDocument",
    "@id": "e3005d38-5c8e-44b2-bf0c-c8d0c9f710d6",
    "url": "http:\/\/s3-eu-west-1.amazonaws.com\/bucket-name\/12345\/5b6981e1-eefe-48e7-9580-31b0987787e7.pdf",
    "pdfDocumentType": "BROCHURE"
  }
}

{
  "realestateproject.attachment": {
    "@xsi.type": "ns2:Link",
    "@id": "969e82fb-6582-4399-a962-7023b8714b97",
    "url": "https:\/\/virtualtours.immobilienscout24.de\/portal\/tour\/1234",
    "linkType": "VIRTUAL_TOUR"
  }
}

Unsuccessful responses

Files not uploaded prior assignment

HTTP Code: 404

XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages
    xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
    xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0">
    <message>
        <messageCode>ERROR_RESOURCE_NOT_FOUND</messageCode>
        <message>Resource [attachment] with id [2e2a7dd7-f746-4087-ac76-8dbf959d5c78] was not found.</message>
    </message>
</common:messages>

JSON:

{
    "common.messages": [
        {
            "message": {
                "messageCode": "ERROR_RESOURCE_NOT_FOUND",
                "message": "Resource [attachment] with id [2e2a7dd7-f746-4087-ac76-8dbf959d5c78] was not found."
            }
        }
    ]
}