HomeEscape API

Service

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

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id
rate	number	yes	Rate id

Response

            
                {
                    "id": 61903,
                    "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": "These price will can change. We respect the price calculated at moment when do it ..."
                }

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!"
`EC013`	`Period not found`	Rate id doesn't match our records	"Sorry, We couldn't find that rate!"
`EC026`	`Period does not belong to the property`	Rate id doesn't belong to the property	"Sorry, We couldn't find that rate!"
`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]
`VID214`	`Invalid input for period`	Rate id is not a number	[Call the API again using a valid value for rate id]