Expose API

SendAFriend

The resource sendafriend represents a forwarding request of a real estate which means a recommendation of it.

https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/{expose_id}/sendafriend

 

Supported methods

SendAFriend/POST

The POST method of this sub-resource represents an action to send an e-mail request to the to an interested person of an real estate.

https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/{expose_id}/sendafriend

 

Note:

  • Please specify only one sendafriend form per call. This call represents the action of sending a expose/contact request to another interested person, thus this request doesn't return a location header cause no resource was created.
  • You must provide the following HTTP headers:
    • - Accept: application/json or application/xml
    • - Content-Type: application/json or application/xml

 

Supported media types

  • XML (Accept: application/xml)
  • JSON (Accept: application/json)

Authorization requirements

At least a System Key is required for this operation. See Authentication via Two-legged OAuth for further details.

Request

Path Parameters

expose_id

    The Id of an expose to perform a sendafriend request for.

Body

Possible values for contactFormType are: EMAIL, LONG, PHONE, NONE which have to match the contactFormType of the expose the contact request is for (except for NONE, where no contact requests are allowed).

The field lastname is always required. Depending on the contactFormType different fields have to be provided in the request:

  • EMAIL: only emailAddress is required
  • LONG: emailAddress, phoneNumber and all fields of address are required
  • PHONE: only phoneNumber is required

In case of requestType APPOINTMENT_REQUEST a list of providerIds (to be contacted) is required, in case of requestType FINANCING_REQUEST no providerIds are needed.

The content of the fields is not filtered (e.g. for cross-side scripting or cross-side request forgery).

If contactRequest.financingType = FOLLOWUP_FINANCING the value of the remaining debt should be mapped to contactRequest.financingTerms.ownFunds.

XML

 

 

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

<expose:sendAFriendForm xmlns:expose="http://rest.immobilienscout24.de/schema/search/expose/1.0">

<recipientName>recipientName</recipientName>

<recipientEmail>recipientEmail@mail.de</recipientEmail>

<senderName>senderName</senderName>

<senderEmail>senderEmail@mail.de</senderEmail>

<comment>leave a message</comment>

</expose:sendAFriendForm>

 

 

 

JSON

 

 

{

"expose.sendAFriendForm":{

"recipientName":"recipientName",

"recipientEmail":"recipientEmail@mail.de",

"senderName":"senderName",

"senderEmail":"senderEmail@mail.de",

"comment":"leave a message"

}

}

 

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 MESSAGE_OPERATION_SUCCESSFUL

Header

No special headers.

Body

XML

 

 

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

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

<message>

<messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>

<message>Operation successful executed.</message>

</message>

</common:messages>

 

 

 

JSON

 

 

{

"common.messages":[ {

"message":{

"messageCode":"MESSAGE_OPERATION_SUCCESSFUL",

"message":"Operation successful executed."

}

} ]

}