HomeEscape API

Service

Name	Add Property
Description	Add information of a property
Method	POST
URL	/properties
Example	/api/properties
Access	OWNER, MANAGER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
name	text	yes	The property name will be visible only to the home owner.
tagline	text	yes	Tagline is the first place that traveler will look. Include useful information about your home.
description	text	yes	Use to provide more specific details about your property.
size	number	yes	Size square of the property.
size_unit	number	yes	0 - Square Feet, 1 - Square Meter, 2 - Square Kilometer.
property_type	number	yes	Check here.
location_types	array	yes	Check here.
bedrooms	number	yes	Number of the bedrooms available for rent.
bathrooms	number	yes	Number of the badrooms available for rent.
half_bath	number	no	Number of the half bathrooms available for rent.
sleeps	number	yes	Number of people that can sleep in the property.
currency	number	yes	Check here.
bedding	text	no	Refer to areas where people can comfortably sleep, i.e. a king sized bed, twin bed, and/or pull-out sofa.
purchased	number	no	Providing the year you’ve purchased your property adds the element of trust and credibility to your listing.
why_this	text	no	Tell a little reasons about the area history, or about your personal history.
benefits	text	no	Describe what’s special about your property, and the unique benefits travelers will enjoy.
luxury	bool	no	Request as luxury property to be listed in the LuxuryEscape section, if the nightly cost is $600 or greater.

Response

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

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!"
`EC008`	`Property type not found`	The property type doesn't match our records	"Please enter a valid property type"
`EC009`	`Location type not found`	The location type doesn't match our records	"Please enter a valid location type"
`EC010`	`Currency not found`	The currency doesn't match our records	"Please enter a valid currency"
`EC011`	`Status not found`	Status: "inactive" doesn't match our records	"Oops! Looks like we hit a snag. Try closing the app and reopening it."
`R111`	`[Property serie]`	The operation was successful	"The property was created successfully"
`R000`	`Fail`	The property wasn't created
`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]
`VID119`	`Invalid input for name`	Name is empty, has more than 80 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please fill out this field" - [Validate the user enter less than 80 characters] - "Please enter a valid text for Property Name"
`VID120`	`Invalid input for tagline`	Tagline is empty, has more than 80 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please fill out this field" - [Validate the user enter less than 80 characters] - "Please enter a valid text for Tagline"
`VID121`	`Invalid input for description`	Description is empty, has less than 200 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please fill out this field" - [Validate the user enter at least 200 characters] - "Please enter a valid text for Description"
`VID113`	`Invalid input for size`	Size is empty or it is not a number	"Please fill out this field" - "Size must have only numbers"
`VID161`	`Invalid input for size_unit`	Size_unit is not in [0, 1, 2]	"Please select an item in the list" - [Call the API again using a valid value for size_unit]
`VID126`	`Invalid input for property_type`	Property_type is empty or it is not a number	"Please select an item in the list" - [Call the API again using a valid value for property_type]
`VID127`	`Invalid input for location_types`	Location_types is empty or it is not an array of numbers	"Please select an item in the list" - [Call the API again using a valid value for location_types]
`VID114`	`Invalid input for bedrooms`	Bedrooms is empty or it is not a number	"Please select an item in the list" - [Call the API again using a valid value for Bedrooms]
`VID115`	`Invalid input for bathrooms`	Bathrooms is empty or it is not a number	"Please select an item in the list" - [Call the API again using a valid value for Bathrooms]
`VID117`	`Invalid input for half_bath`	Half_bathrooms is not a number	[Call the API again using a valid value for half_bath]
`VID116`	`Invalid input for sleeps`	Sleeps is empty or it is not a number	"Please select an item in the list" - [Call the API again using a valid value for Sleeps]
`VID128`	`Invalid input for currency`	Currency is empty or it is not a number	"Please select an item in the list" - [Call the API again using a valid value for Currency]
`VID122`	`Invalid input for bedding`	Bedding has more than 200 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	[Validate the user enter less than 200 characters] - "Please enter a valid text for Bedding Arrangement"
`VID123`	`Invalid input for purchased`	Purchased year is not a number	[Validate the user enter only 4 numbers] - "Please enter a valid year (ex: 1980)."
`VID124`	`Invalid input for why_this`	Why_this has more than 2000 characters or it has only characters not allowed (" ", ', ’, ‘, ’, ", &, \, <, >, --)	[Validate the user enter less than 2000 characters] - "Please enter a valid text for Why this Property?"
`VID125`	`Invalid input for benefits`	Benefits has more than 2000 characters or it has only characters not allowed (" ", ', ’, ‘, ’, ", &, \, <, >, --)	[Validate the user enter less than 2000 characters] - "Please enter a valid text for Unique Benefits"
`VID218`	`Invalid input for luxury`	Luxury is not in [0, 1]	[Call the API again using a valid value for luxury]