Skip to content

Retrieve all OnTop placement

This method provides a method to get all Ontop placed real estates. There are 3 different ontop placements, you'll need to send 1 request for each of them.

GET /offer/v1.0/user/{username or me}/{ontop placement}/all

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
ontop placement the type of the ontop placement (showcaseplacement, premiumplacement or topplacement)

Example

  1. https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/me/showcaseplacement/all

  2. https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/me/premiumplacement/all

  3. https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/me/topplacement/all

Response

XML

<premiumplacement:premiumplacements xmlns:toplisting="http://rest.immobilienscout24.de/schema/offer/premiumplacement/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
   <premiumplacement realestateid="70631305">
      <messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>
      <message>toplisted</message>
      <servicePeriod>
         <dateFrom>2014-01-28T14:18:54.000+01:00</dateFrom>
      </servicePeriod>
      <externalId>myBestObject567</externalId>
   </premiumplacement>
   <premiumplacement realestateid="70631304">
      <messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>
      <message>toplisted</message>
      <servicePeriod>
         <dateFrom>2014-01-28T14:18:31.000+01:00</dateFrom>
      </servicePeriod>
      <externalId>7854985</externalId>
   </premiumplacement>
</premiumplacement:premiumplacements>