GETAll 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.

https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username or me}/{ontop placement}/all

Example requests:

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

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

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

Possible OnTop Placements:

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

Supported media types

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

Authorization requirements

A System Key and an authenticated user are required for this operation:

Please use a secure connection (https) for this operation.

Request

Path Parameters

  • Username: the username which the user uses for logging in to www.immobilienscout24.
  • Username: "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)

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


<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>