HomeEscape API

Service

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

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id

Response

            
                {
                    "cleaning_fee": 20,
                    "cleaning_tax": false,
                    "pet_fee": 50,
                    "pet_tax": true,
                    "lodging_tax": 10,
                    "sales_tax": 10,
                    "damage_deposit": 500,
                    "damage_deposit_hold": true,
                    "damage_deposit_hold_days": 5,
                    "other_fees": [],
                    "cancellation_policy": "No-Refund",
                    "cancellation_policy_additional": "",
                    "type_payment": 1,
                    "first_payment": 50,
                    "second_payment": 50,
                    "due_date": 7,
                    "max_stay": "7",
                    "check_in": "null",
                    "check_out": "null",
                    "deposit_requirements": "null",
                    "house_rules": "null"
                }

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!"
`SC006`	`User not 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]