Skip to content

Retrieve an OnTop placement

This method provides a way to get information about the OnTop Placement of a real estate.

GET /offer/v1.0/user/{username or me}/realestate/{id or externalId}/{ontop placement}

Supported media types:
XML
JSON

Possible OnTop Placements:

  • showcaseplacement ("Schaufenster-Platzierung")
  • premiumplacement ("Premium-Platzierung")
  • topplacement ("Top-Platzierung")

Request

Path Parameters

PARAMETER DESCRIPTION
Username the username which the user uses for logging in to www.immobilienscout24
me "me" can be used instead of the username, when the user is logged in by 3-legged oauth
id the unique scout object ID, which is being created by POST REALESTATE automatically
external-id can be used instead of the scout object ID. it is the customer-defined ID of the real estate, must be unique per user
ontop placement the type of the OnTop placement (showcaseplacement, premiumplacement or topplacement)

Response

XML: 

1
2
3
4
5
6
7
8
9
<premiumplacement:premiumplacements xmlns:toplisting="http://rest.immobilienscout24.de/schema/offer/premiumplacement/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
   <premiumplacement realestateid="53483572">
      <messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>
      <message>premium placed</message>
      <servicePeriod>
         <dateFrom>2014-01-28T13:17:10.000+01:00</dateFrom>
      </servicePeriod>
   </premiumplacement>
</premiumplacement:premiumplacements>

or unsuccessful response:

1
2
3
4
5
6
<premiumplacement:premiumplacements xmlns:toplisting="http://rest.immobilienscout24.de/schema/offer/premiumplacement/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
   <toplisting realestateid="53483572">
      <messageCode>ERROR_REQUESTED_DATA_NOT_FOUND</messageCode>
      <message>not premium placed</message>
   </premiumplacement>
</premiumplacement:premiumplacements>