GETbyID OnTop Placement

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

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

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.
  • 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)

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="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:

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