HomeEscape API

Service

Name	Edit Owner Policies
Description	Edit the policies of the owner
Method	PUT
URL	/owner/policies
Example	/api/owner/policies
Access	OWNER, MANAGER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
damage_deposit_hold	bool	no	Allow to HomeEscape hold the damage deposit, is required if damage_deposit has value.
damage_deposit_hold_days	number	no	Number the days to hold damage deposit after checkin (3-30), is required if damage_deposit has value.
cancellation_policy	text	yes	Flexible, Standard, Rigid, Strict, No-Refund, Other.
cancellation_policy_additional	text	no	Additional information about policy for cancellation.
type_payment	number	yes	0 - Single Payment, 1 - Multi Payment.
first_payment	number	no	Required if multi payment, then first_payment + second_payment = 100.
second_payment	number	no	Required if multi payment, then first_payment + second_payment = 100.
due_date	number	no	Required if multi payment, value between 0 and 90.
max_stay	number	no	Maximum of nigth that the traveler may reserve.
check_in	time	no	Only hour between 0 and 23.
check_out	time	no	Only hour between 0 and 23.
deposit_requirements	text	no	Information about deposit requirements.
house_rules	text	no	Information about house rules.

Response

            
                {
                    "code": R111,
                    "message": "Success"
                }

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!"
`R000`	`Fail`	The owner policies request wasn't updated
`R111`	`Success`	The operation was successful	"Your policies were successfully updated."
`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]
`VID194`	`Invalid input for damage_deposit_hold`	Damage_deposit_hold is not in [0, 1]	[Call the API again using a valid value for damage_deposit_hold]
`VID195`	`Invalid input for cancellation_policy`	Cancellation_policy is empty or it is not in ["Flexible", "Standard", "Rigid", "Strict", "No-Refund", "Other"]	"Please select an item in the list" - [Call the API again using a valid value for cancellation_policy]
`VID196`	`Invalid input for cancellation_policy_additional`	Cancellation_policy_additional is empty, has more than 2000 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please fill out this field" - "Please enter a valid text for Additional Information"
`VID197`	`Invalid input for type_payment`	Type_payment is not in [0, 1]	[Call the API again using a valid value for type_payment]
`VID198`	`Invalid input for first_payment`	First_payment is not a number between 0-100	[Call the API again using a valid value for first_payment]
`VID199`	`Invalid input for second_payment`	Second_payment is not a number between 0-100	[Call the API again using a valid value for second_payment]
`VID200`	`Invalid input the sum of payments must equal 100 percent`	The sum of First_payment + Second_payment is not a number between 0-100	[Call the API again using a valid value for first_payment and/or second_payment]
`VID201`	`Invalid input for due_date`	Due_date is not a number between 0-90	[Call the API again using a valid value for due_date]
`VID202`	`Invalid input for check_in`	Check_in is not a number between 0-23	[Call the API again using a valid value for check_in hour]
`VID203`	`Invalid input for check_out`	Check_out is not a number between 0-23	[Call the API again using a valid value for check_out hour]
`VID204`	`Invalid input for max_stay`	Max_stay is not a number	[Call the API again using a valid value for max_stay]
`VID205`	`Invalid input for deposit_requirements`	Deposit_requirements has more than 2000 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please enter a valid text for Deposit Requirements"
`VID206`	`Invalid input for house_rules`	House_rules has more than 2000 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please enter a valid text for House Rules"
`VID215`	`Invalid input for damage_deposit_hold_days`	Damage_deposit_hold_days is not a number between 3-30	[Call the API again using a valid value for damage_deposit_hold_days]
`VID241`	`Invalid input for for_all`	For_all is not in [0, 1]	[Call the API again using a valid value for for_all]