{"_id":"5b1693c53421d40003cbe3a9","project":"56e3719a591f620e00bf5095","version":{"_id":"56e3719a591f620e00bf5098","hasReference":true,"hasDoc":true,"__v":6,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab","59c952f57f6bea002e57da0a","59c954f07f6bea002e57da14","59cb3f6b487a0e00261deb5c","59cd714c360c8600242c4984"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"category":{"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"56e371538b32a10e00f79750","githubsync":"","__v":6,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-05T13:44:37.318Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"name\": \"name\",\n        \"shortSummary\": \"Short summary\",\n        \"summary\": \"summary\",\n        \"notes\": \"notes\",\n        \"access\": \"access\",\n        \"transit\": \"transit\",\n        \"interaction\": \"interaction\",\n        \"neighborhood\": \"Neighborhoond\",\n        \"locale\": \"en_US\",\n        \"space\": \"space\"\n    },\n    {\n      \t\"name\": \"name\",\n        \"shortSummary\": \"Short summary\",\n        \"summary\": \"summary\",\n        \"notes\": \"notes\",\n        \"access\": \"accés\",\n        \"transit\": \"transport\",\n        \"interaction\": \"interaction\",\n        \"neighborhood\": \"voisinage\",\n        \"locale\": \"fr_FR\",\n        \"space\": \"espace\"\n    }\n]","name":""},{"name":"","status":400,"language":"text","code":"Orbirental API - Bad request."},{"status":409,"language":"text","code":"Orbirental API - Property not found."}]},"settings":"","auth":"required","params":[{"_id":"56e75cbb5669091700c5b2b2","ref":"","in":"path","required":true,"desc":"The unique ID of the property","default":"","type":"string","name":"uid"}],"url":"/propertydescriptions/:uid"},"isReference":false,"order":49,"body":"","excerpt":"Retrieve the property descriptions to the provided property unique id.","slug":"propertydescriptionsuid","type":"endpoint","title":"/propertydescriptions/:uid"}

get/propertydescriptions/:uid

Retrieve the property descriptions to the provided property unique id.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

uid:
required
string
The unique ID of the property

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}