{"_id":"5aceeeca3951ec0003267b16","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":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-12T05:29:46.562Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \t\"id\": 26,\n    \"propertyUid\": \"f64ef28f-426c-4711-aaee-af82e8d18844\",\n  \t\"name\": \"Hard Rock Cafe\",\n  \t\"address\": \"256 Pier 39 Concourse\",\n  \t\"city\": \"San Francisco\",\n    \"zipCode\": \"94133\",\n  \t\"state\": \"California\",\n    \"note\": \"Nice place to hangout\",\n    \"latitude\": 37.8094752,\n    \"longitude\": -122.4101291\n}","name":""},{"status":400,"language":"text","code":"Orbirental API - Bad request.","name":""},{"code":"Orbirental API - Invalid Longitude or Latitude","language":"text","status":400},{"code":"Orbirental API - Missing parameters.","language":"text","status":409},{"code":"Orbirental API - Could not retrieve property with the provided propertyUid","language":"text","status":409}]},"settings":"","auth":"required","params":[{"_id":"5ad0d545e059eb0003feceb4","ref":"","in":"body","required":true,"desc":"The unique ID of the property","default":"","type":"string","name":"propertyUid"},{"_id":"5ad0d545e059eb0003feceb3","ref":"","in":"body","required":true,"desc":"Name of the Local Spot","default":"","type":"string","name":"name"},{"_id":"5ad0d545e059eb0003feceb2","ref":"","in":"body","required":true,"desc":"An Address of the Local Spot","default":"","type":"string","name":"address"},{"_id":"5ad0d545e059eb0003feceb1","ref":"","in":"body","required":true,"desc":"City in which the Local Spot is located","default":"","type":"string","name":"city"},{"_id":"5ad0d545e059eb0003feceb0","ref":"","in":"body","required":true,"desc":"Zip Code of the City","default":"","type":"string","name":"zipCode"},{"_id":"5ad0d545e059eb0003feceaf","ref":"","in":"body","required":true,"desc":"State in which the city is located","default":"","type":"string","name":"state"},{"_id":"5ad0d545e059eb0003feceae","ref":"","in":"body","required":true,"desc":"A Description of the Local Spot","default":"","type":"string","name":"note"},{"_id":"5ad0d545e059eb0003fecead","ref":"","in":"body","required":false,"desc":"Latitude Geolocation of the Local Spot","default":"","type":"double","name":"latitude"},{"_id":"5ad0d545e059eb0003feceac","ref":"","in":"body","required":false,"desc":"Longitude Geolocation of the Local Spot","default":"","type":"double","name":"longitude"}],"url":"/localspots"},"isReference":false,"order":30,"body":"","excerpt":"","slug":"localspots-1","type":"endpoint","title":"/localspots"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

propertyUid:
required
string
The unique ID of the property
name:
required
string
Name of the Local Spot
address:
required
string
An Address of the Local Spot
city:
required
string
City in which the Local Spot is located
zipCode:
required
string
Zip Code of the City
state:
required
string
State in which the city is located
note:
required
string
A Description of the Local Spot
latitude:
double
Latitude Geolocation of the Local Spot
longitude:
double
Longitude Geolocation of the Local Spot

Result Format


User Information

Try It Out

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