GetUnits() returns a list of the bookable units for a business.
Caution: Once an advertiser has organized their units into groups, units will no longer be available.
REQUEST
End Point https://www.availabilityexchange.com/gateway/getunits Parameters business_id (64-bit integer) unique id of the business unit_id (32-bit integer = null) unique id of the unit. More than one id can be specified. If omitted, all units for the specified business will be returned
response_errors (See Response Errors) business_id (64-bit integer) the unique identifier for this business units (list of objects) unit_id (32-bit integer) the unique identifier for the unit name (string) the unit name description (string) the unit description capacity (integer) the total adults the unit can hold default_rate (decimal) DepricatedDeprecated) default nightly rate (business currency) fees_per_stay (decimal) total of all fees to be charged per stay fees_per_day (decimal) total of all fees to be charged per day image_urls (List of strings) the urls of any publicly available images of the unit. These images provided by the property and are their responsibility. If no urls are available, this field is omitted unit_group_id (32-bit integer?) the id of the unit group the unit is assigned to, if any. If null, this field will be omitted. See GetUnitGroups() for more info unit_type (enum?) if configured by the property, this is one of the following types: ROOM CABIN TENT_SITE RV_SITE EVENT_SPACE EQUIPMENT_RENTAL site_length (double?) if configured by the property, this is the site length (in feet). Generally only populated for unit_type RV_SITE site_amps (enum?) if configured by the property, this is the types of RV amperage the site supports: TWENTY_AMPS THIRTY_AMPS FIFTY_AMPS site_features (enum?) if configured by the property, this is a list of features the site has: PULL_THROUGH BACK_IN SEWER WATER PARKING_SPACE TENT_SPACE
EXAMPLE RESPONSE
{ "response_errors": [], "business_id": 12345, "units": [ { "unit_id": 27795, "name": "FD10 Double Full Room ", "description": "Enjoy two soft amazing full size suite.", "capacity": 2, "default_rate": 0.0, "fees_per_stay": 0.0, "fees_per_day": 0.0, "unit_type": ROOM }, { "name": "R17 RV Site 17", "description": "Each RV site has water, electric (20A/30A/50A receptacles), and sewer hook-ups, a fire pit/grill, and a picnic table. A separate dock is dedicated for the use of RV campers.\r\n\r\nA \"comfort station\" is located next to the RV sites, which has two flush toilets and two coin-operated showers.\r\n\r\nIf you wish to choose a specific RV site, make your campsite selection via the Map tab.", "capacity": 6, "default_rate": 0.0, "fees_per_stay": 0.0, "fees_per_day": 0.0, "image_urls": [ "https://d8qysm09iyvaz.cloudfront.net/subscribers/4004829C-51BA-4527-8472-F2AB6AD1A9BD/7/eaa8a314-f8e5-46b6-8d5d-e50c46cc7cf8.jpg", "https://d8qysm09iyvaz.cloudfront.net/subscribers/4004829C-51BA-4527-8472-F2AB6AD1A9BD/7/76347d0d-7d44-4ba7-8047-cb2b577b2862.jpg", "https://d8qysm09iyvaz.cloudfront.net/subscribers/4004829C-51BA-4527-8472-F2AB6AD1A9BD/7/a93eba02-0c4a-49a7-b919-a1e99a8041d4.jpg", "https://d8qysm09iyvaz.cloudfront.net/subscribers/4004829C-51BA-4527-8472-F2AB6AD1A9BD/7/337d4ffe-b835-470b-828b-7eff56ce3f8e.jpg", "https://d8qysm09iyvaz.cloudfront.net/subscribers/4004829C-51BA-4527-8472-F2AB6AD1A9BD/7/52194b5c-43d3-4daa-ac26-ef644ff65db8.jpg" ], "unit_type": "RV_SITE", "unit_id": 3411, "site_length": "50", "site_amps": "TWENTY_AMPS, THIRTY_AMPS, FIFTY_AMPS", "site_features": "BACK_IN, SEWER, WATER, PARKING_SPACE, TENT_SPACE" } ] }
RESPONSE ERRORS
200 response_errors (list of strings) Unable to access Units for Business 400 business_id should be a long 401
This site requires a secure connection over HTTPS
The credentials supplied are incorrect or you do not have access to this resource
500 Something went wrong (Internal Server Error) 503 Server in maintenance mode
