Exposé
This tutorial shows you the possibilities of the resource Expose.
accessing an expose
- Methode: GET
Request-URL:
https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/{exposeid}
Example
Path Parameters
- exposeid - the unique scout id of an expose
Query Parameters
- none
How do you get an expose id? Simpley start a real estate search on http://www.immobilienscout24.de untill you have an expose and copy the expose id from the url.
Enter the id in the api request:
https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/123456
XML
it's a get request: you don't have to send anything in the body.
Result:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<expose:expose 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/offer/realestates/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/search/financeCalculator/1.0" xmlns:expose="http://rest.immobilienscout24.de/schema/search/expose/1.0" creation="2011-06-16T09:36:15.000+02:00" modification="2011-06-16T09:36:22.000+02:00" id="123456" xlink:href="http://sandbox.immobilienscout24.de/restapi/api/search/v1.0/expose/123456" contactFormType="LONG"> <realEstate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="expose:ApartmentRent" id="123456">
<title>Tutorial Expose</title>
<creationDate>2011-06-16T09:36:15.000+02:00</creationDate>
<lastModificationDate>2011-06-16T09:36:22.000+02:00</lastModificationDate>
<address>
<street>Andreasstraße</street>
<houseNumber>10</houseNumber>
<postcode>10243</postcode>
<city>Berlin</city>
<quarter>Friedrichshain (Friedrichshain)</quarter>
<wgs84Coordinate>
<latitude>52.51231237755847</latitude> <longitude>13.431192476026999</longitude>
</wgs84Coordinate>
<geoHierarchy>
<continent>
<geoCodeId>1</geoCodeId>
<fullGeoCodeId>1</fullGeoCodeId>
</continent>
<country>
<name>Deutschland</name>
<geoCodeId>276</geoCodeId>
<fullGeoCodeId>1276</fullGeoCodeId>
</country>
<region>
<name>Berlin</name>
<geoCodeId>3</geoCodeId>
<fullGeoCodeId>1276003</fullGeoCodeId>
</region>
<city>
<name>Berlin</name>
<geoCodeId>1</geoCodeId>
<fullGeoCodeId>1276003001</fullGeoCodeId>
</city>
<quarter>
<name>Friedrichshain (Friedrichshain)</name>
<geoCodeId>17</geoCodeId>
<fullGeoCodeId>1276003001017</fullGeoCodeId>
</quarter>
<neighbourhood>
<geoCodeId>11000000002348</geoCodeId>
</neighbourhood>
</geoHierarchy>
</address>
<descriptionNote>Super</descriptionNote>
<furnishingNote>Echt toll!</furnishingNote>
<locationNote>Traumhaft</locationNote>
<otherNote>Einwandfrei</otherNote>
<state>ACTIVE</state>
<apartmentType>NO_INFORMATION</apartmentType>
<lift>false</lift> <assistedLiving>false</assistedLiving> <cellar>NOT_APPLICABLE</cellar>
<handicappedAccessible>NOT_APPLICABLE</handicappedAccessible>
<condition>NO_INFORMATION</condition>
<courtage>
<hasCourtage>NO</hasCourtage>
</courtage>
<buildingEnergyRatingType>NO_INFORMATION</buildingEnergyRatingType>
<energyConsumptionContainsWarmWater>NOT_APPLICABLE</energyConsumptionContainsWarmWater>
<guestToilet>NOT_APPLICABLE</guestToilet>
<baseRent>321.00</baseRent>
<heatingCostsInServiceCharge>NOT_APPLICABLE</heatingCostsInServiceCharge>
<petsAllowed>NO_INFORMATION</petsAllowed> <livingSpace>69.00</livingSpace>
<numberOfRooms>2</numberOfRooms>
<energyPerformanceCertificate>false</energyPerformanceCertificate>
<builtInKitchen>false</builtInKitchen>
<balcony>false</balcony>
<certificateOfEligibilityNeeded>false</certificateOfEligibilityNeeded>
<garden>false</garden>
<floorplan>false</floorplan>
</realEstate>
<contactDetails id="">
<salutation>MALE</salutation>
<firstname>Immobilienscout24</firstname>
<lastname>Immobilienscout24</lastname>
<faxNumber>+49 30 24301-1110</faxNumber>
<address>
<street>Andreasstrasse</street>
<houseNumber>10</houseNumber>
<postcode>10243</postcode>
<city>Berlin</city>
</address>
<countryCode>DEU</countryCode>
<company>Immobilien Scout GmbH</company>
<homepageUrl>http://www.immobilienscout24.de</homepageUrl>
<realtorLogo>https://tpicture.immobilienscout24.de/files/logo/N/78/271/627/logo-6.jpg?3806990325</realtorLogo>
</contactDetails>
</expose:expose>
JSON
it's a get request: you don't have to send anything in the body.
Result:
{
"expose.expose":{
"@creation":"2011-06-16T09:36:15.000+02:00",
"@modification":"2011-06-16T09:36:22.000+02:00",
"@id":"59503459",
"@xlink.href":"https:\/\/sandbox.immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/123456",
"@contactFormType":"LONG",
"realEstate":{
"@xsi.type":"expose:ApartmentRent",
"@id":"123456",
"title":"Tutorial Expose",
"creationDate":"2011-06-16T09:36:15.000+02:00",
"lastModificationDate":"2011-06-16T09:36:22.000+02:00",
"address":{
"street":"andreasstraße",
"houseNumber":10,
"postcode":10243,
"city":"Berlin",
"quarter":"Friedrichshain (Friedrichshain)",
"wgs84Coordinate":{
"latitude":52.51231237755847,
"longitude":13.431192476026999
},
"geoHierarchy":{
"continent":{
"geoCodeId":1,
"fullGeoCodeId":"1"
},
"country":{
"name":"Deutschland",
"geoCodeId":276,
"fullGeoCodeId":"1276"
},
"region":{
"name":"Berlin",
"geoCodeId":3,
"fullGeoCodeId":"1276003"
},
"city":{
"name":"Berlin",
"geoCodeId":1,
"fullGeoCodeId":"1276003001"
},
"quarter":{
"name":"Friedrichshain (Friedrichshain)",
"geoCodeId":17,
"fullGeoCodeId":"1276003001017"
},
"neighbourhood":{
"geoCodeId":11000000002348
}
}
},
"descriptionNote":"Super",
"furnishingNote":"Echt toll!",
"locationNote":"Traumhaft",
"otherNote":"Einwandfrei",
"state":"ACTIVE",
"apartmentType":"NO_INFORMATION",
"lift":false,
"assistedLiving":false,
"cellar":"NOT_APPLICABLE",
"handicappedAccessible":"NOT_APPLICABLE",
"condition":"NO_INFORMATION",
"courtage":{ "hasCourtage":"NO"
},
"buildingEnergyRatingType":"NO_INFORMATION",
"energyConsumptionContainsWarmWater":"NOT_APPLICABLE",
"guestToilet":"NOT_APPLICABLE",
"baseRent":"321.00",
"heatingCostsInServiceCharge":"NOT_APPLICABLE",
"petsAllowed":"NO_INFORMATION",
"livingSpace":"69.00",
"numberOfRooms":2,
"energyPerformanceCertificate":false,
"builtInKitchen":false,
"balcony":false,
"certificateOfEligibilityNeeded":false,
"garden":false,
"floorplan":false
},
"contactDetails":{
"@id":"",
"salutation":"MALE",
"firstname":"Immobilienscout24",
"lastname":"Immobilienscout24",
"faxNumber":"+49 30 24301-1110",
"address":{
"street":"Andreasstrasse",
"houseNumber":10,
"postcode":10243,
"city":"Berlin"
},
"countryCode":"DEU",
"company":"Immobilien Scout GmbH",
"homepageUrl":"http:\/\/www.immobilienscout24.de",
"realtorLogo":"http:\/\/tpicture.immobilienscout24.de\/files\/logo\/N\/78\/271\/627\/logo-6.jpg?3806990325"
}
}
}
access an attachment to an expose
Methode: GET
Request-URL:
https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/{exposeid}/attachment/{attachmentid}
Example
Path Parameters
exposeid
attachmentid
Query Parameters
none
https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/123456/attachment/123456
XML
it's a get request: you don't have to send anything in the body.
Result:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:attachment xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="common:Picture" creation="2011-06-29T09:54:19.197+02:00" modification="2011-06-29T09:54:19.203+02:00" id="640076605" xlink:href="http://sandbox.immobilienscout24.de/restapi/api/search/v1.0/expose/123456/attachment/123456">
<title>Straßenansicht</title>
<floorplan>false</floorplan>
<urls>
<url href="http://tpicture.immobilienscout24.de/files/result002/N/78/856/846/78856846-4.jpg?3475998531" scale="SCALE_60x60"/>
<url href="http://tpicture.immobilienscout24.de/files/odw002/N/78/856/846/78856846-3.jpg?3475998531" scale="SCALE_118x118"/>
<url href="http://tpicture.immobilienscout24.de/files/expose002/N/78/856/846/78856846-2.jpg?3475998531" scale="SCALE_210x210"/>
<url href="http://tpicture.immobilienscout24.de/files/basic002/N/78/856/846/78856846-1.jpg?3475998531" scale="SCALE_540x540"/>
</urls>
</common:attachment>
JSON
it's a get request: you don't have to send anything in the body.
Result:
{
"common.attachment": {
"@xsi.type":"common:Picture",
"@creation":"2011-06-29T09:58:43.244+02:00",
"@modification":"2011-06-29T09:58:43.244+02:00",
"@id":"640076605",
"@xlink.href":"http:\/\/sandbox.immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/123456\/attachment\/123456",
"title":"Straßenansicht",
"floorplan":false,
"urls":[{
"url":[{
"@href":"http:\/\/tpicture.immobilienscout24.de\/files\/result002\/N\/78\/856\/846\/78856846-4.jpg?3475998531",
"@scale":"SCALE_60x60"}, {"@href":"http:\/\/tpicture.immobilienscout24.de\/files\/odw002\/N\/78\/856\/846\/78856846-3.jpg?3475998531","@scale":"SCALE_118x118"
},
{
"@href":"http:\/\/tpicture.immobilienscout24.de\/files\/expose002\/N\/78\/856\/846\/78856846-2.jpg?3475998531"
"@scale":"SCALE_210x210"
},
{
"@href":"http:\/\/tpicture.immobilienscout24.de\/files\/basic002\/N\/78\/856\/846\/78856846-1.jpg?3475998531",
"@scale":"SCALE_540x540"
}
]}
] }
}
send a contact request to an Expose
Methode: POST
Request-URL:
https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/{exposeid}/contact
Example
Path Parameters
exposeid
Query Parameters
none
The creation of a request to a expose is accesible with the resource "/expose/{exposeid}" with the parameter "contact". It is necessary to send a body as xml- or json-format. Consequently the URL looks like the following:
https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/123456/contact
XML
In the body you send the contact form:
<expose:contactForm xmlns:expose="http://rest.immobilienscout24.de/schema/search/expose/1.0" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://rest.immobilienscout24.de/schema/search/expose/1.0 expose-1.0.xsd" contactFormType="LONG">
<firstname>Max</firstname>
<lastname>Mustermann</lastname>
<phoneNumber>12345678</phoneNumber>
<emailAddress>max@mustermann.de</emailAddress>
<appointmentRequested>YES</appointmentRequested>
<message>Dies ist eine Anfrage zu Ihrem Expose</message>
<address xsi:type="common:Address">
<street>Musterstraße</street>
<houseNumber>123</houseNumber>
<postcode>12345</postcode>
<city>Musterstadt</city>
</address>
</expose:contactForm>
Result:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
<message>
<messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>
<message>Operation successful executed.</message>
</message>
</common:messages>
JSON
In the body you send the contact form:
{
expose.contactForm:{
@xmlns:{
"common":"http:\/\/rest.immobilienscout24.de\/schema\/common\/1.0"},
@contactFormType:"LONG",
firstname:"Max",
lastname:"Mustermann",
phoneNumber:"12345678",
emailAddress:"max@mustermann.de",
appointmentRequested:"YES",
message:"message",
address: {
"@xsi.type":"common:Address",
street:"Musterstraße",
houseNumber:"123",
postcode:"12345",
city:"Musterstadt"
}
}
}
Result:
{
"common.messages":[{
"message": {
"messageCode":"MESSAGE_OPERATION_SUCCESSFUL",
"message":"Operation successful executed."
}
}]
}
Recommending a expose
Methode: POST
Request-URL:
https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/{exposeid}/sendafriend
Example
Path Parameters
exposeid - the ID of an expose
Query Parameters
none
To send a recommendation to an expose, you need the resource "/expose/{exposeid}" and the sub resource "sendafriend". It is mandatory to send a body as xml- or jsoon format. Consequently the URL looks like the following:
https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/123456/sendafriend
XML
In the body you send the recommendation as a form:
<?xml version="1.0" encoding="UTF-8"?>
<expose:sendAFriendForm xmlns:expose="https://rest.immobilienscout24.de/schema/search/expose/1.0">
<recipientName>Ein Freund</recipientName>
<recipientEmail>ein@freund.de</recipientEmail>
<senderName>Max Mustermann</senderName>
<senderEmail>max@mustermann.de</senderEmail>
<comment>Schau dir mal unbedingt dieses super tolle Objekt an.</comment>
</expose:sendAFriendForm>
Result:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:common="https://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
<message>
<messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>
<message>Operation successful executed.</message> </message>
</common:messages>
JSON
In the body you send the recommendation as a form:
{
expose.sendAFriendForm: {
recipientName:"Ein Freund",
recipientEmail:"ein@freund.de",
senderName:"Max Mustermann",
senderEmail:"max@mustermann.de",
comment:"Schau dir mal unbedingt dieses super tolle Objekt an.",
}
}
Result:
{
"common.messages": [{
"message": {
"messageCode":"MESSAGE_OPERATION_SUCCESSFUL",
"message":"Operation successful executed."
}
}]
}