{"__v":4,"_id":"56e77f259b25270e001d1232","category":{"__v":19,"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"56e3719a591f620e00bf5095","user":"56e371538b32a10e00f79750","version":{"__v":2,"_id":"56e3719a591f620e00bf5098","hasDoc":true,"hasReference":true,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"updates":["58f2a45ac980971900cfb9bf"],"next":{"pages":[],"description":""},"createdAt":"2016-03-15T03:19:01.492Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"uid\": \"4f6a3a32-6d57-450d-8b46-44abb3b01994\",\n  \"isActive\": true,\n\t\"description\": \"This Point Reyes House is located on a quiet rural lane, 2 mns from the village of Point Reyes Station, just one hour north of downtown San Francisco.\",\n  \"baseGuests\": 4,\n  \"cleaningFeeAmount\": 160,\n  \"baseDailyRate\": 220,\n  \"acceptInstantBook\": false,\n  \"bathrooms\": 2,\n  \"maximumGuests\": 6,\n  \"state\": \"California\",\n  \"countryCode\": \"US\",\n  \"securityDepositAmount\": 500,\n  \"address1\": \"159 Campolindo Road\",\n  \"webLink\": \"http://point-reyes-vacation-rental.com/\",\n  \"address2\": \"\",\n  \"externalID\": \"\",\n  \"bedrooms\": 2,\n  \"type\": \"HOUSE\",\n  \"city\": \"Point Reyes Station\",\n  \"picture\": \"https://www.orbirental.com/img/uploader/livingroom4_1.jpg\",\n  \"postalCode\": \"94956\",\n  \"name\": \"The Quail's Nest Cottage\",\n  \"minimumStay\": 1,\n  \"availabilityCalendarUrl\" : \"https://www.orbirental.com/calendar/232.ics\",\n  \"photos\": [\n    {\n      \"url\": \"https://www.orbirental.com/img/uploader/view_0.jpg\",\n      \"description\" : \"my house\"\n    }\n  ],\n  \"externalCalendarUrls\": [\n    {\n      \"name\": \"Wimdu\",\n      \"source\": \"IMPORT_OTHER_PROVIDER\",\n      \"url\": \"http://www.wimdu.com/offers/OOQHSNHS/calendar.ics?token=7ece1efghtr\"\n    }\n  ],\n  \"rules\": {\n    \"increaseRateLowerBound\": 6,\n    \"decreaseRateHigherBound\": 10,\n    \"increaseRate\": 15,\n    \"decreaseRate\": 20\n  },\n  \"rentalConditions\": [\n    {\n      \"description\": \"No Pets\"\n    },\n    {\n      \"description\": \"No smoking inside the house\"\n    }\n  ],\n  \"floor\": 2,\n  \"areaSize\": 30,\n  \"areaSizeUnit\": \"SQUARE_METERS\",\n  \"extraGuestFee\": 50,\n  \"taxationRate\": 12.5,\n  \"longitude\" : 48.1914945,\n  \"latitude\" : 19.1914945,\n  \"airBnBID\" : 123456,\n  \"flipkeyID\" : 78910,\n  \"homeAwayID\" : 72910,\n  \"currency\": \"USD\",\n  \"shortDescription\": \"This Point Reyes House is located on a quiet rural lane\",\n  \"panoramicDataUrl\": \"https://my.matterport.com/show/?m=123456\",\n  \"cancellationPolicy\": \"Here is the cancellation policy.\",\n  \"propertyURL\": \"https://www.orbirental.com/vacation-rental-property/232/haight-place\"\n}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Property not found.","language":"text","status":409}]},"settings":"","auth":"required","params":[{"_id":"56e75cbb5669091700c5b2b2","ref":"","in":"path","required":true,"desc":"The unique ID of the property","default":"","type":"string","name":"uid"}],"url":"/properties/:uid"},"isReference":false,"order":28,"body":"Small error in the JSON response. The trailing comma in the rentalConditions array breaks the JSON:\n\n    {\n      \"description\": \"No smoking inside the house\"\n    },","excerpt":"Retrieve the property associated to the provided unique id and agency unique id.","slug":"propertiesuid","type":"endpoint","title":"/properties/:uid"}

get/properties/:uid

Retrieve the property associated to the provided unique id and agency unique id.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

uid:
required
string
The unique ID of the property

Result Format


Documentation

Small error in the JSON response. The trailing comma in the rentalConditions array breaks the JSON: { "description": "No smoking inside the house" },

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