Skip to content

Add OnTop to many Realestates

This method provides a method to add an OnTop placement to your real estates by list.

POST /offer/v1.0/user/{username or me}/{ontop placement}/list

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)

XML:

<premiumplacement:premiumplacements xmlns:premiumplacement="http://rest.immobilienscout24.de/schema/offer/premiumplacement/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
   <premiumplacement realestateid="75013664"/>
   <premiumplacement realestateid="75013665"/>
   <premiumplacement realestateid="75013666"/>
   <premiumplacement realestateid="ext-75013667"/>
   <premiumplacement realestateid="ext-750136648"/>
</premiumplacement:premiumplacements>

JSON:

{
   "premiumplacement.premiumplacements":{
      "premiumplacement":[
         {
            "@realestateid":"70631394"
         },
         {
            "@realestateid":"70631395"
         },
         {
            "@realestateid":"70631393"
         },
         {
            "@realestateid":"ext-A765665X"
         },
         {
            "@realestateid":"ext-O6395WSD"
         }
      ]
   }
}

Response

XML:

<?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="75013664">
        <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
        <message>[real estate with id='75013665' is already premium placed.]</message>
    </premiumplacement>
    </premiumplacement>
    <premiumplacement realestateid="75013665">
        <messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>
        <message>premium placed</message>
    </premiumplacement>
    <premiumplacement realestateid="75013666">
        <messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>
        <message>premium placed</message>
    </premiumplacement>
    <premiumplacement realestateid="ext-75013667">
        <messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>
        <message>premium placed</message>
    </premiumplacement>
    <premiumplacement realestateid="ext-750136648">
        <messageCode>ERROR_RESOURCE_NOT_FOUND</messageCode>
        <message>[real estate with id='ext-750136648' could not be found.]</message>
    </premiumplacement>
</premiumplacement:premiumplacements>

JSON:

{
    "premiumplacement:premiumplacements": {
        "premiumplacement": [
            {
                "@realestateid": "75013664",
                "messageCode": "ERROR_RESOURCE_VALIDATION",
                "message": "[real estate with id='75013665' is already premium placed.]"
            },
            {
                "@realestateid": "75013665",
                "messageCode": "MESSAGE_OPERATION_SUCCESSFUL",
                "message": "premium placed"
            },
            {
                "@realestateid": "75013666",
                "messageCode": "MESSAGE_OPERATION_SUCCESSFUL",
                "message": "premium placed"
            },
            {
                "@realestateid": "ext-75013667",
                "messageCode": "MESSAGE_OPERATION_SUCCESSFUL",
                "message": "premium placed"
            },
            {
                "@realestateid": "ext-750136648",
                "messageCode": "ERROR_RESOURCE_NOT_FOUND",
                "message": "[real estate with id='ext-750136648' could not be found.]"
            }
        ]
    }
}