{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/propertydescriptions/:uid","auth":"required","method":"put","examples":{"codes":[]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"summary\": \"long description\",\n  \"name\": \"name\",\n  \"shortSummary\": \"Short summary\",\n  \"notes\": \"notes\",\n  \"access\": \"access\",\n  \"transit\": \"transit\",\n  \"interaction\": \"interaction\",\n  \"neighborhood\": \"Neighborhoond\",\n  \"locale\": \"en_US\",\n  \"space\": \"space\"\n}","name":""},{"status":400,"language":"text","code":"Orbirental API - Bad request.","name":""},{"status":409,"language":"text","code":"Orbirental API - Service Provider not found."}]},"params":[{"name":"uid","type":"string","default":"","desc":"Unique ID of the property","required":true,"in":"path","ref":"","_id":"5923600aa341250f008c701e"},{"name":"locale","type":"string","default":"en_US","desc":"en_US, fr_FR, es_ES, de_DE, nl_NL, pt_PT","required":false,"in":"body","ref":"","_id":"59235f547180400f00049012"},{"name":"name","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5bc6bbef8d41a2005c328104"},{"name":"summary","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b1696b0f4ae2500039441d0"},{"name":"shortSummary","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5bc6bbef8d41a2005c328103"},{"name":"notes","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b1696b0f4ae2500039441cf"},{"name":"transit","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b1696b0f4ae2500039441ce"},{"name":"interaction","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b1696b0f4ae2500039441cd"},{"name":"neighborhood","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b1696b0f4ae2500039441cc"},{"name":"space","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b1696b0f4ae2500039441cb"},{"name":"access","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b1699e4f4ae25000394428c"}]},"next":{"description":"","pages":[]},"title":"/propertydescriptions/:uid","type":"endpoint","slug":"propertydescriptionsuid-2","excerpt":"Edit or create a property description","body":"","updates":[],"order":62,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3388","project":"56e3719a591f620e00bf5095","version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"user":"56e371538b32a10e00f79750","createdAt":"2018-06-05T13:55:11.817Z","githubsync":"","__v":7,"parentDoc":null}

put/propertydescriptions/:uid

Edit or create a property description

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

uid:
required
string
Unique ID of the property

Body Params

locale:
stringen_US
en_US, fr_FR, es_ES, de_DE, nl_NL, pt_PT
name:
string
summary:
string
shortSummary:
string
notes:
string
transit:
string
interaction:
string
neighborhood:
string
space:
string
access:
string

Result Format


User Information

Try It Out

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