POSTbyList OnTop-Placement

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

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

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

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

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 201 Created
  • This status code is returned after a new entity of a resource was successfully created.

Header

No special headers.

Body

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.]"
            }
        ]
    }
}