POST /v2/properties/insert
Creates property from json or xml representation of the object.
Resource information
| Authentication | Yes |
| Request Formats | json,xml |
| Response Formats | json,xml |
| HTTP Method | POST |
| Request Object | Property |
| Response Object | Result |
| XSD Download | Download |
| API Version | v2 |
Example Request
https://api.poplidays.com/v2/properties/insert
json post body
{
"name": "L'Orée du Golf 2",
"typeCode": "maison",
"owner": {
"firstName": "Karim",
"lastName": "DELCI",
"phone": "+34977384021",
"address": "Rue Robert Contesse n°15 2053 Cernier"
},
"company": {
"firstName": "Gaime",
"lastName": "Alain",
"phone1": "04 67 26 55 16",
"phone2": "06 28 25 35 54",
"name": "CAPIMMOBILIER.COM"
},
"options": {
"accessibility": true,
"animals": true,
"lift": true,
"bath": true,
"barbecue": true,
"billiards": true,
"heater": true,
"fireplace": true,
"classification": "***",
"airConditioning": true,
"comfort": "",
"freezer": true,
"extraBed": true,
"equipedKitchen": true,
"generalDescription": "General",
"digitalLock": true,
"distanceToInnerCity": "+ 500m",
"distanceToLake": "",
"distanceToSea": "501m - 1000m",
"distanceToSki": "",
"shower": true,
"collectiveGardenArea": true,
"floor": "5",
"expositionRank": "***",
"areaRank": "***",
"oven": true,
"smoking": true,
"internet": true,
"intercom": true,
"hotTub": true,
"garden": true,
"gardenArea": "5",
"washingMachine": true,
"dishwasher": true,
"accomodationRank": "***",
"microwave": true,
"miniOven": true,
"gardenFurniture": true,
"bedRoomNumber": "5",
"singleBedsNumber": "5",
"doubleBedsNumber": "5",
"roomNumber": "5",
"bathroomNumber": "5",
"bathroomWaterNumber": "3",
"roomsWaterNumber": "2",
"toiletsNumber": "5",
"pingpong": true,
"swimmingpool": true,
"sauna": true,
"parking": true,
"surface": "5",
"television": true,
"terrace": true,
"quiteAreaRank": "***",
"countrySide": "Golf",
"separatedToilets": true,
"locality": "hebergement.mer",
"maximumGuestsNumber": "5",
"separatedToiletsNumber": "5",
"location": "***",
"environmentRank": "****",
"equipmentRank": "***",
"accessibilityRank": "***",
"distanceToShopping": "0m - 100m",
"closeToGolf": "true",
"balcony": true,
"dryer": true,
"cot": true,
"swimmingpoolPrivate": true,
"swimmingpoolPrivateArea": "5",
"swimmingpoolCollective": true,
"swimmingpoolCollectiveArea": "50m*5m",
"tennis": true,
"distanceToBus": "0m - 100m",
"distanceToMetro": "0m - 100m",
"distanceToTram": "0m - 100m",
"distanceToTaxi": "0m - 100m",
"recommendedTransport": "tout.à.pied",
"wifi": true
},
"address": {
"line1": "Rue des Tropiques",
"line2": "Villa 33",
"line3": "Villa 33",
"postalCode": "34300",
"city": "Paris",
"country": "FR"
},
"provider": {
"providerId": "Channel",
"providerReference": "2142342141",
"providerUrl": "https://www.poplidays.com",
"externalReference": "ACMASOS"
},
"localisation": {
"latitude": 43.2818148,
"longitude": 3.4932812,
"altitude": 2000
},
"comment": "There is a comment",
"services": [
{
"serviceId": 1,
"price": 20,
"serviceOption": "MANDATORY_ON_BOOKING",
"externalReference": "uid"
},
{
"serviceId": 2,
"price": 23,
"serviceOption": "OPTIONAL_ON_BOOKING"
}
],
"outsideDescription": {
"type": "SMALL_BUILDING",
"landscape": "BY_THE_STREET",
"area": "IN_A_PICTURESQUE_AREA",
"near": "CLOSE_TO_THE_SLOPES",
"recommendedTransport": "ALL_WALKING",
"parking": "NOT_PRIVATE_PARKING",
"collectivePoolOpening": {
"day": 2,
"month": 10,
"year": 2013
},
"collectivePoolClosure": {
"day": 31,
"month": 10,
"year": 2013
}
},
"generalDescription": {
"qualifier": "NICE",
"type": "APARTMENT",
"design": "MODERN",
"including": "WITH_GARDEN",
"floor": "ON_THE_X_FLOOR",
"level": 3,
"withElevator": true,
"place": "IN_A_LARGE_HOUSE",
"layout": "WITH_PLEASANT_LAYOUT",
"area": "LIVING_AREA_WITH_LIVING_ROOM_CORNER",
"opening": "OPENING_ON_THE_TERRACE",
"kitchen": "OPEN_KITCHEN",
"cookingStoves": "WITH_X_COOKING_STOVES",
"numberOfCookingStoves": 4,
"kitchenSpecification": "FUNCTIONAL"
},
"bedroomDescriptions": [
{
"numberOfRooms": 1,
"largeBed": true,
"largeBedDimensions": "311",
"twinBeds": true,
"twinBedsDimensions": "321",
"truckleBed": true,
"truckleBedDimensions": "90",
"foldableBed": true,
"foldableBedDimensions": "120",
"bunkBeds": true,
"bunkBedsDimensions": "2",
"smallBeds": true,
"smallBedsDimensions": "1",
"television": true,
"showerRoom": true,
"bathroom": true,
"wc": true,
"mezzanine": true,
"externalExit": true,
"alcoveType": true,
"localisation": "ON_THE_X_FLOOR",
"level": 4
},
{
"numberOfRooms": 2,
"largeBed": true,
"largeBedDimensions": "123",
"twinBeds": true,
"twinBedsDimensions": "123",
"truckleBed": true,
"truckleBedDimensions": "311",
"foldableBed": false,
"bunkBeds": true,
"bunkBedsDimensions": "123",
"smallBeds": true,
"smallBedsDimensions": "333",
"television": true,
"showerRoom": true,
"bathroom": true,
"wc": true,
"mezzanine": false,
"externalExit": true,
"alcoveType": true,
"localisation": "ENTRESOL"
}
],
"localizedDescriptions": [
{
"locale": "de",
"general": "Schöne moderne Ferienvilla. Auf der n2 Etage mit bequemer Einrichtung. Wohnzimmer mit Fensterfront zum Garten. Offene Küche funktional 2 Herdplatten. 2 Zimmer mit großem Bett 140.",
"outside": "Schöne Ferienvilla mit gepflegtem Garten in einem ruhigen Viertel. In der Nähe eines Golfplatzes gelegen. Auto wird empfohlen. Privativer Stellplatz im Freien."
},
{
"locale": "fr",
"general": "Belle villa moderne. Sur 2 niveau(x)avec aménagement agréable. Séjour avec baie vitrée donnant sur jardin. Cuisine ouverte fonctionnelle avec 2 plaque(s) de cuisson. 2 chambre(s) avec grand lit de 140.",
"outside": "Belle villa avec jardin soigné, dans quartier calme. Situé(e) à proximité d'un golf. Voiture conseillée. Stationnement privatif avec place de parking en extérieur."
}
],
"additionalDescriptions": [
{
"type": "PREPEND",
"descriptions": [
{
"locale": "fr",
"text": "test"
},
{
"locale": "en",
"text": "test en"
}
]
}
],
"scoreA": 1231,
"scoreB": 245,
"scoreC": 214,
"scoreD": 786,
"residenceCode": "Pop-64-212",
"regulationValues": [
{
"type":"ventanilla",
"value":"ventanilla-id-test"
}
],
"images": [
{
"caption": "Image1",
"URL": "http://www.poplidays.com/output/information/prestation/38/P1000521%20%5Bpoplidays%20petite%5D.JPG"
},
{
"name": "Image2",
"URL": "http://www.poplidays.com/output/information/prestation/38/033%20%5Bpoplidays%20petite%5D.JPG"
},
{
"name": "Image3",
"URL": "http://www.poplidays.com/output/information/prestation/40/DSC_1188%20%5Bpoplidays%20petite%5D.JPG"
}
]
}
xml post body
https://api.poplidays.com/v2/properties/xsd
<?xml version="1.0" encoding="UTF-8" ?>
<property>
<name>L'Orée du Golf 2</name>
<typeCode>maison</typeCode>
<owner>
<firstName>Karim</firstName>
<lastName>DELCI</lastName>
<phone>+34977384021</phone>
<address>Rue Robert Contesse n°15 2053 Cernier</address>
</owner>
<company>
<firstName>Gaime</firstName>
<lastName>Alain</lastName>
<phone1>04 67 26 55 16</phone1>
<phone2>06 28 25 35 54</phone2>
<name>CAPIMMOBILIER.COM</name>
</company>
<options>
<accessibility>true</accessibility>
<animals>true</animals>
<lift>true</lift>
<bath>true</bath>
<barbecue>true</barbecue>
<billiards>true</billiards>
<heater>true</heater>
<fireplace>true</fireplace>
<classification>***</classification>
<airConditioning>true</airConditioning>
<comfort/>
<freezer>true</freezer>
<extraBed>true</extraBed>
<equipedKitchen>true</equipedKitchen>
<generalDescription>General</generalDescription>
<digitalLock>true</digitalLock>
<distanceToInnerCity>+ 500m</distanceToInnerCity>
<distanceToLake/>
<distanceToSea>501m - 1000m</distanceToSea>
<distanceToSki/>
<shower>true</shower>
<collectiveGardenArea>true</collectiveGardenArea>
<floor>5</floor>
<expositionRank>***</expositionRank>
<areaRank>***</areaRank>
<oven>true</oven>
<smoking>true</smoking>
<internet>true</internet>
<intercom>true</intercom>
<hotTub>true</hotTub>
<garden>true</garden>
<gardenArea>5</gardenArea>
<washingMachine>true</washingMachine>
<dishwasher>true</dishwasher>
<accomodationRank>***</accomodationRank>
<microwave>true</microwave>
<miniOven>true</miniOven>
<gardenFurniture>true</gardenFurniture>
<bedRoomNumber>5</bedRoomNumber>
<singleBedsNumber>5</singleBedsNumber>
<doubleBedsNumber>5</doubleBedsNumber>
<roomNumber>5</roomNumber>
<bathroomNumber>5</bathroomNumber>
<bathroomWaterNumber>3</bathroomWaterNumber>
<roomsWaterNumber>2</roomsWaterNumber>
<toiletsNumber>5</toiletsNumber>
<pingpong>true</pingpong>
<swimmingpool>true</swimmingpool>
<sauna>true</sauna>
<parking>true</parking>
<surface>5</surface>
<television>true</television>
<terrace>true</terrace>
<quiteAreaRank>***</quiteAreaRank>
<countrySide>Golf</countrySide>
<separatedToilets>true</separatedToilets>
<locality>hebergement.mer</locality>
<maximumGuestsNumber>5</maximumGuestsNumber>
<separatedToiletsNumber>5</separatedToiletsNumber>
<location>***</location>
<environmentRank>****</environmentRank>
<equipmentRank>***</equipmentRank>
<accessibilityRank>***</accessibilityRank>
<distanceToShopping>0m - 100m</distanceToShopping>
<closeToGolf>true</closeToGolf>
<balcony>true</balcony>
<dryer>true</dryer>
<cot>true</cot>
<swimmingpoolPrivate>true</swimmingpoolPrivate>
<swimmingpoolPrivateArea>5</swimmingpoolPrivateArea>
<swimmingpoolCollective>true</swimmingpoolCollective>
<swimmingpoolCollectiveArea>50m*5m</swimmingpoolCollectiveArea>
<tennis>true</tennis>
<distanceToBus>0m - 100m</distanceToBus>
<distanceToMetro>0m - 100m</distanceToMetro>
<distanceToTram>0m - 100m</distanceToTram>
<distanceToTaxi>0m - 100m</distanceToTaxi>
<recommendedTransport>tout.à.pied</recommendedTransport>
<wifi>true</wifi>
</options>
<address>
<line1>Rue des Tropiques</line1>
<line2>Villa 33</line2>
<line3>Villa 33</line3>
<postalCode>34300</postalCode>
<city>Paris</city>
<country>FR</country>
</address>
<provider>
<providerId>Channel</providerId>
<providerReference>2142141</providerReference>
<providerUrl>http://poplidays.com</providerUrl>
</provider>
<localisation>
<latitude>43.2818148</latitude>
<longitude>3.4932812</longitude>
<altitude>2000</altitude>
</localisation>
<comment>There is a comment</comment>
<services>
<serviceId>1</serviceId>
<price>20</price>
<serviceOption>MANDATORY_ON_BOOKING</serviceOption>
<externalReference>${UID}</externalReference>
</services>
<services>
<serviceId>2</serviceId>
<price>23</price>
<serviceOption>OPTIONAL_ON_BOOKING</serviceOption>
</services>
<outsideDescription>
<type>SMALL_BUILDING</type>
<landscape>BY_THE_STREET</landscape>
<area>IN_A_PICTURESQUE_AREA</area>
<near>CLOSE_TO_THE_SLOPES</near>
<recommendedTransport>ALL_WALKING</recommendedTransport>
<parking>NOT_PRIVATE_PARKING</parking>
<collectivePoolOpening>
<day>2</day>
<month>10</month>
<year>2013</year>
</collectivePoolOpening>
<collectivePoolClosure>
<day>31</day>
<month>10</month>
<year>2013</year>
</collectivePoolClosure>
</outsideDescription>
<generalDescription>
<qualifier>NICE</qualifier>
<type>APARTMENT</type>
<design>MODERN</design>
<including>WITH_GARDEN</including>
<floor>ON_THE_X_FLOOR</floor>
<level>3</level>
<withElevator>true</withElevator>
<place>IN_A_LARGE_HOUSE</place>
<layout>WITH_PLEASANT_LAYOUT</layout>
<area>LIVING_AREA_WITH_LIVING_ROOM_CORNER</area>
<opening>OPENING_ON_THE_TERRACE</opening>
<kitchen>OPEN_KITCHEN</kitchen>
<cookingStoves>WITH_X_COOKING_STOVES</cookingStoves>
<numberOfCookingStoves>4</numberOfCookingStoves>
<kitchenSpecification>FUNCTIONAL</kitchenSpecification>
</generalDescription>
<bedroomDescriptions>
<numberOfRooms>1</numberOfRooms>
<largeBed>true</largeBed>
<largeBedDimensions>311</largeBedDimensions>
<twinBeds>true</twinBeds>
<twinBedsDimensions>321</twinBedsDimensions>
<truckleBed>true</truckleBed>
<truckleBedDimensions>90</truckleBedDimensions>
<foldableBed>true</foldableBed>
<foldableBedDimensions>120</foldableBedDimensions>
<bunkBeds>true</bunkBeds>
<bunkBedsDimensions>2</bunkBedsDimensions>
<smallBeds>true</smallBeds>
<smallBedsDimensions>1</smallBedsDimensions>
<television>true</television>
<showerRoom>true</showerRoom>
<bathroom>true</bathroom>
<wc>true</wc>
<mezzanine>true</mezzanine>
<externalExit>true</externalExit>
<alcoveType>true</alcoveType>
<localisation>ON_THE_X_FLOOR</localisation>
<level>4</level>
</bedroomDescriptions>
<bedroomDescriptions>
<numberOfRooms>2</numberOfRooms>
<largeBed>true</largeBed>
<largeBedDimensions>123</largeBedDimensions>
<twinBeds>true</twinBeds>
<twinBedsDimensions>123</twinBedsDimensions>
<truckleBed>true</truckleBed>
<truckleBedDimensions>311</truckleBedDimensions>
<foldableBed>false</foldableBed>
<bunkBeds>true</bunkBeds>
<bunkBedsDimensions>123</bunkBedsDimensions>
<smallBeds>true</smallBeds>
<smallBedsDimensions>333</smallBedsDimensions>
<television>true</television>
<showerRoom>true</showerRoom>
<bathroom>true</bathroom>
<wc>true</wc>
<mezzanine>false</mezzanine>
<externalExit>true</externalExit>
<alcoveType>true</alcoveType>
<localisation>ENTRESOL</localisation>
</bedroomDescriptions>
<additionalDescriptions>
<additionalDescription type="PREPAND_DESCRIPTION">
<description locale="fr">
<text>test</text>
</description>
<description locale="en">
<text>test en</text>
</description>
<description locale="es">
<text>test es2</text>
</description>
</additionalDescription>
<additionalDescription type="APPEND_DESCRIPTION">
<description locale="fr">
<text>test</text>
</description>
</additionalDescription>
</additionalDescriptions>
<localizedDescriptions>
<locale>de</locale>
<general>Schöne moderne Ferienvilla. Auf der n2 Etage mit bequemer Einrichtung. Wohnzimmer
mit Fensterfront zum Garten. Offene Küche funktional 2 Herdplatten. 2 Zimmer mit großem
Bett 140.</general>
<outside>Schöne Ferienvilla mit gepflegtem Garten in einem ruhigen Viertel. In der Nähe
eines Golfplatzes gelegen. Auto wird empfohlen. Privativer Stellplatz im
Freien.</outside>
</localizedDescriptions>
<localizedDescriptions>
<locale>fr</locale>
<general>Belle villa moderne. Sur 2 niveau(x)avec aménagement agréable. Séjour avec baie
vitrée donnant sur jardin. Cuisine ouverte fonctionnelle avec 2 plaque(s) de cuisson. 2
chambre(s) avec grand lit de 140.</general>
<outside>Belle villa avec jardin soigné, dans quartier calme. Situé(e) à proximité d'un
golf. Voiture conseillée. Stationnement privatif avec place de parking en
extérieur.</outside>
</localizedDescriptions>
<scoreA>1231</scoreA>
<scoreB>245</scoreB>
<scoreC>214</scoreC>
<scoreD>786</scoreD>
<residenceCode>Pop-64-212</residenceCode>
<images>
<caption>Image1</caption>
<URL>http://www.poplidays.com/output/information/prestation/38/P1000521%20%5Bpoplidays%20petite%5D.JPG</URL>
</images>
<images>
<name>Image2</name>
<URL>http://www.poplidays.com/output/information/prestation/38/033%20%5Bpoplidays%20petite%5D.JPG</URL>
</images>
<images>
<name>Image3</name>
<URL>http://www.poplidays.com/output/information/prestation/40/DSC_1188%20%5Bpoplidays%20petite%5D.JPG</URL>
</images>
<residentialUsage>main</residentialUsage>
<regulationValues>
<type>ventanilla</type>
<value>test-ventanilla</value>
</regulationValues>
</property>