HomeEscape API

Service

Name	Get Property Contact
Description	Get the contact person of a property
Method	GET
URL	/properties/{property}/contacts
Example	/api/properties/11111111/contacts
Access	EVERYONE

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Id of the property.

Response

            
                {
                    "name": "John Dev",
                    "name_display": true,
                    "phone1": "7863334444",
                    "phone1_display": true,
                    "phone1_sms": true,
                    "phone2": "null",
                    "phone2_display": "null",
                    "phone2_sms": "null",
                    "phone3": "null",
                    "phone3_display": "null",
                    "phone3_sms": "null",
                    "email": "johndev@homeescape.com",
                    "email_display": "null",
                    "fax": "null",
                    "fax_display": "null",
                    "member_since": "2015",
                    "languages": {
                      "english": true,
                      "spanish": true,
                      "russian": false,
                      "chinese": false,
                      "german": false,
                      "french": false,
                      "arabic": false,
                      "portuguese": false
                    }
                }

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!"
`R000`	`Fail`
`R111`	`Success`	The operation was successful
`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]