Real Estate

Real Estate/DeletebyID

Deletes the resource identified by the following URL.This methods deletes a real estate object by scout object ID or externalId.

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

DELETE is idempotent.

Example: DELETE https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username}/realestate/123456: Deletes the real estate object with scout object ID=123456.

We recommend not to delete objects, but to deactivate them, instead. You can use the [publish] service for deactivating.

 

 

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.

 

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

This status code is returned after an entity of a resource was successfully deleted.

 

Header

  • none

 

Body

 

XML

 

 

<?xml version="1.0" encoding="UTF-8"?>

<common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">

<message>

<messageCode>MESSAGE_RESOURCE_DELETED</messageCode>

<message>Resource [realestate] with id [123456] has been deleted.</message>

<id>123456</id>

</message>

</common:messages>

 

 

 

 

 JSON

 

 

{

"common.messages":[ {

"message":{

"messageCode":"MESSAGE_RESOURCE_DELETED",

"message":"Resource [realestate] with id [123456] has been deleted."

"id":62544913

}

} ]

}