Skip to content

Add OnTop to a Real Estate

This method provides a way to add an OnTop Placement to your real estates by ID.

POST /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")

Note: that PremiumPlacement is WITHOUT Body.

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
<common:messages xmlns:ns2="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
   <message>
      <messageCode>MESSAGE_RESOURCE_CREATED</messageCode>
      <message>Resource [premiumplacement] with id [] has been created.</message>
   </message>
</common:messages>

or 412 (real estate not published): 

1
2
3
4
5
6
<common:messages xmlns:ns2="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
   <message>
      <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
      <message>Error while validating input for the resource. [MESSAGE: premiumplacement for this real estate is not possible:Not allowed to perform OnTop for unpublished realestate (#70631302).]</message>
   </message>
</common:messages>