HomeEscape API

Service

Name	Get Property Rates
Description	Get the rates of a property
Method	GET
URL	/properties/{property}/rates
Example	/api/properties/11111111/rates
Access	EVERYONE

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id

Response

            
                [
                    {
                      "id": 00001,
                      "rates_type": "seasonal",
                      "period_name": "Standard Rate",
                      "minimum_stay": 2,
                      "nightly": 50,
                      "weekly": 300,
                      "monthly": 1200,
                      "weekend_charge": true,
                      "weekend_price": 5,
                      "guest_fee": true,
                      "guest_price": 25,
                      "guest_quantity": 1,
                      "notes": ""                          
                    },
                    {
                      "id": 00002,
                      "rates_type": "seasonal",
                      "period_name": "Summer",
                      "start_date": "2017-06-23T00:00:00-0400",
                      "end_date": "2017-09-23T00:00:00-0400",
                      "minimum_stay": 3,
                      "nightly": 60,
                      "weekly": 360,
                      "monthly": 0,
                      "weekend_charge": false,
                      "weekend_price": 0,
                      "guest_fee": false,
                      "guest_price": 0,
                      "guest_quantity": 0,
                      "notes": ""
                    },
                    {
                      "id": 00003,    
                      "rates_type": "holiday",
                      "period_name": "July 4",
                      "start_date": "2017-04-03T00:00:00-0400",
                      "end_date": "2017-04-05T00:00:00-0400",
                      "holiday_price": 180,
                      "notes": ""
                    }
                ]

Response Codes

Code	Message	Cause	Possible Frontend Message [Behavior]
`EC000`	`Internal error in API`	Internal error connecting the database	"Oops! Looks like we hit a snag. Try closing the app and reopening it."
`EC001`	`User not found`	Token user id doesn't match our records	"Sorry, We couldn't find your information!"
`EC002`	`Property not found`	Property id doesn't match our records	"Sorry, We couldn't find that property!"
`EC004`	`Not found result`	The property doesn't have rates
`SC006`	`User no authorization`	The token role is not valid for using the API services	"You have been logged out." - [Take the user to the login screen]
`SC014`	`Expired token`	The token has expired	"You have been logged out." - [Take the user to the login screen]
`VID112`	`Invalid input for property`	Property id is not a number	[Call the API again using a valid value for property id]