DELETEbyID OnTop Placement

This method provides a method to delete a list of OnTop Placements. This means, that the connection of a certain real estate to the OnTop Placement is being deleted, not the OnTop Placement booking. This method can only be used every 24 hours.

https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username or me}/{ontop placement}/list?realestateids={realestateid,ext-externalid,...}

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.
  • realestateid: the unique scout object ID, which is being created by POST REALESTATE automatically.
  • externalid: 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:premiumplacement="http://rest.immobilienscout24.de/schema/offer/premiumplacement/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
   <premiumplacement realestateid="ext-API1414510357267">
      <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
      <message>[premiumplacement for realestate with id='75911415' can not be deleted before 2014-10-29T16:32:40.000+01:00]</message>
   </premiumplacement>
   <premiumplacement realestateid="75911415 ">
      <messageCode>MESSAGE_RESOURCE_DELETED</messageCode>
      <message>Resource [premiumplacement] has been deleted.</message>
   </premiumplacement>
</premiumplacement:premiumplacements>