{"_id":"5de85dbbb0b885003ddf3386","project":"56e3719a591f620e00bf5095","version":{"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Domain","version_clean":"1.5.0","version":"1.5"},"category":{"_id":"5de85dbbb0b885003ddf3334","pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"5de85dbbb0b885003ddf339f","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,"metadata":{"title":"","description":"","image":[]},"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":61,"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 }}