Contact

Contact/Post

This method creates a contact adress for an ImmobilienScout24 user.

https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username}/contact/

Notes

  • The telephone numbers can be entered in three separate parts (country code, area code (Ortsvorwahl) and telephone number) or as single input field but with the same seperate field restrictions!
  • Field restrictions:
  •     Country code (Ländervorwahl):  „00“ ist not allowed, it needs to be „+"
  •     Area code (Regionvorwahl): if Countrycode = "+49", than we disallow an area code which starts with „0"
  •     Spaces are the only valid divider within these fields.
  • These fields are mandatory, although they can be optional in the schema: last name and email.
  • Duplicate check (POST/PUT Contact) compares the following fields: salutation, first name, last name, street, housenumber, zip, city, country code, phone, fax, cell phone, homepage, email
  • The fields "officeHours" and "company" are no more used in the IS24 website
  • only 20 contacts with "showOnProfilePage" could be have the value "true"
  • External id which contains "/" needs to be url encoded

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

  • 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.

Query Parameters

none

Body

XML

minimum xml

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:realtorContactDetail xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns4="http://rest.immobilienscout24.de/schema/customer/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/user/1.0" >
    <email>contactAddress@is24.de</email>
    <lastname>lastname</lastname>
</common:realtorContactDetail>

 

maximum xml

 

<?xml version="1.0" encoding="UTF-8"?>
<common:realtorContactDetail xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns4="http://rest.immobilienscout24.de/schema/customer/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/user/1.0" >
    <email>max.mustermann@immobilienscout24.de</email>
    <salutation>MALE</salutation>
    <firstname>Max</firstname>
    <lastname>Mustermann</lastname>
    <faxNumberCountryCode>+49</faxNumberCountryCode>
    <faxNumberAreaCode>30</faxNumberAreaCode>
    <faxNumberSubscriber>243010001</faxNumberSubscriber>
    <phoneNumberCountryCode>+49</phoneNumberCountryCode>
    <phoneNumberAreaCode>30</phoneNumberAreaCode>
    <phoneNumberSubscriber>243010001</phoneNumberSubscriber>
    <cellPhoneNumberCountryCode>+49</cellPhoneNumberCountryCode>
    <cellPhoneNumberAreaCode>179</cellPhoneNumberAreaCode>
    <cellPhoneNumberSubscriber>24301000</cellPhoneNumberSubscriber>
    <address>
        <street>Andreasstr.</street>
        <houseNumber>10</houseNumber>
        <postcode>10243</postcode>
        <city>Berlin</city>
    </address>
    <countryCode>DEU</countryCode>
    <title>Master</title>
    <additionName>HuiBuh</additionName>
    <company>Immobilienscout24, field is no more used or visible in the is24 website</company>
    <homepageUrl>http://www.immobilienscout24.de</homepageUrl>
    <position>position oder taetigkeit im unternehmen</position>
    <officeHours>Von 11:30 bis 12:00, dabei eine halbe Stunde Pause, field is no more used or visible in the is24 website</officeHours>
    <defaultContact>false</defaultContact>
    <localPartnerContact>false</localPartnerContact>
    <businessCardContact>false</businessCardContact>
    <realEstateReferenceCount>2</realEstateReferenceCount>
    <externalId>a-001</externalId>
    <showOnProfilePage>true</showOnProfilePage>   
</common:realtorContactDetail>

 

2nd option to send numbers (instead of the three seperate fields):

...
<faxNumber>+49 30 12345</faxNumber>
<phoneNumber>+49 30 54321</phoneNumber>
<cellPhoneNumber>+49 172 1234567</cellPhoneNumber>
...

Note: a given complete number (phoneNumber, faxNumber, cellPhoneNumber) is only considered if no corresponding number part (...CountryCode, ...AreaCode, ...Subscriber) is given.

JSON

{
  "common.realtorContactDetail" : {
    "email" : "dontReply@me.de",
    "salutation" : "MALE",
    "firstname" : "Max",
    "lastname" : "Mustermann",
    "faxNumberCountryCode":"+49",
    "faxNumberAreaCode":"30",
    "faxNumberSubscriber":"24301111",
    "phoneNumberCountryCode" : "+49",
    "phoneNumberAreaCode" : "30",
    "phoneNumberSubscriber" : "243010000",
    "cellPhoneNumberCountryCode" : "+49" ,
    "cellPhoneNumberAreaCode" : "152",
    "cellPhoneNumberSubscriber": "123123" ,
    "address" : {
      "street" : "Andreasstr.",
      "houseNumber" : "10",
      "postcode" : "10243",
      "city" : "Berlin"
    },
    "countryCode" : "DEU",
    "title" : "Dr.",
    "additionName" : "HuiBuh" ,
    "company" : "Immobilienscout24, field is no more used or visible in the is24 website" ,
    "homepageUrl" : "http://www.immobilienscout24.de" ,
    "position":"position oder taetigkeit im unternehmen",
    "officeHours" : "Von  11:30 bis 12:00, dabei eine halbe Stunde Pause, field is no more used or visible in the is24 website" ,
    "defaultContact" : false,
    "localPartnerContact" : false,
    "businessCardContact" : false,
    "realEstateReferenceCount" : 1,
    "externalId" : "fremdID",
    "showOnProfilePage":"true"   
 }
}

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

Location Link to the newly created resource.

Body

XML

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <common:messages xmlns:ns2="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
     <message>
       <messageCode>MESSAGE_RESOURCE_CREATED</messageCode>
       <message>Resource [contact] with id [123456] has been created.</message>
        <id>123456</id>

     </message>

</common:messages>

 

 

JSON

 

{
    "common:messages": {
        "message": {
            "messageCode": "MESSAGE_RESOURCE_CREATED",
            "message": "Resource [contact] with id [123456] has been created.",
            "id": "123456"
        }
    }
}