{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/localspots","auth":"required","method":"post","examples":{"codes":[]},"results":{"codes":[{"name":"","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}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"status":400,"language":"text","code":"Orbirental API - Invalid Longitude or Latitude"},{"status":409,"language":"text","code":"Orbirental API - Missing parameters."},{"status":409,"language":"text","code":"Orbirental API - Could not retrieve property with the provided propertyUid"}]},"settings":"","params":[{"name":"propertyUid","type":"string","default":"","desc":"The unique ID of the property","required":true,"in":"body","ref":"","_id":"5ad0d545e059eb0003feceb4"},{"name":"name","type":"string","default":"","desc":"Name of the Local Spot","required":true,"in":"body","ref":"","_id":"5ad0d545e059eb0003feceb3"},{"name":"address","type":"string","default":"","desc":"An Address of the Local Spot","required":true,"in":"body","ref":"","_id":"5ad0d545e059eb0003feceb2"},{"name":"city","type":"string","default":"","desc":"City in which the Local Spot is located","required":true,"in":"body","ref":"","_id":"5ad0d545e059eb0003feceb1"},{"name":"zipCode","type":"string","default":"","desc":"Zip Code of the City","required":true,"in":"body","ref":"","_id":"5ad0d545e059eb0003feceb0"},{"name":"state","type":"string","default":"","desc":"State in which the city is located","required":true,"in":"body","ref":"","_id":"5ad0d545e059eb0003feceaf"},{"name":"note","type":"string","default":"","desc":"A Description of the Local Spot","required":true,"in":"body","ref":"","_id":"5ad0d545e059eb0003feceae"},{"name":"latitude","type":"double","default":"","desc":"Latitude Geolocation of the Local Spot","required":false,"in":"body","ref":"","_id":"5ad0d545e059eb0003fecead"},{"name":"longitude","type":"double","default":"","desc":"Longitude Geolocation of the Local Spot","required":false,"in":"body","ref":"","_id":"5ad0d545e059eb0003feceac"}]},"next":{"description":"","pages":[]},"title":"/localspots","type":"endpoint","slug":"localspots-1","excerpt":"","body":"","updates":[],"order":39,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf337c","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-04-12T05:29:46.562Z","githubsync":"","__v":2,"parentDoc":null}

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 }}