DELETEall OnTop Placement

This method provides a method to delete all OnTop placed real estates. Please be careful by using this method.

https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username or me}/{ontop placement}/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="70631394">
      <messageCode>MESSAGE_RESOURCE_DELETED</messageCode>
      <message>de-toplisted</message>
      <servicePeriod>
         <dateFrom>2014-01-28T14:25:06.000+01:00</dateFrom>
      </servicePeriod>
   </premiumplacement>
   <premiumplacement realestateid="70631395">
      <messageCode>MESSAGE_RESOURCE_DELETED</messageCode>
      <message>de-toplisted</message>
      <servicePeriod>
         <dateFrom>2014-01-28T14:25:10.000+01:00</dateFrom>
      </servicePeriod>
   </premiumplacement>
   <premiumplacement realestateid="70631393">
      <messageCode>MESSAGE_RESOURCE_DELETED</messageCode>
      <message>de-toplisted</message>
      <servicePeriod>
         <dateFrom>2014-01-28T14:25:01.000+01:00</dateFrom>
      </servicePeriod>
   </premiumplacement>
</premiumplacement:premiumplacement>

or unsuccessful response:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<premiumplacement:premiumplacements xmlns:premiumplacement="http://rest.immobilienscout24.de/schema/offer/premiumplacement/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
    <premiumplacement realestateid="71765338">
        <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
        <message>[toplisting for realestate with id='71765338' can not be deleted before 2014-02-18T10:04:05.000+01:00]</message>
        <servicePeriod>
            <dateFrom>2014-02-17T10:04:05.000+01:00</dateFrom>
        </servicePeriod>
    </premiumplacement>
    <premiumplacement realestateid="71765365">
        <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
        <message>[toplisting for realestate with id='71765365' can not be deleted before 2014-02-18T10:05:37.000+01:00]</message>
        <servicePeriod>
            <dateFrom>2014-02-17T10:05:37.000+01:00</dateFrom>
        </servicePeriod>
    </premiumplacement>
    <premiumplacement realestateid="71765336">
        <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
        <message>[toplisting for realestate with id='71765336' can not be deleted before 2014-02-18T10:04:05.000+01:00]</message>
    </premiumplacement>
</premiumplacement:premiumplacements>