HomeEscape API

Service

Name	Get Background Images
Description	Returns the images showed as a background in the search box
Method	GET
URL	/images/backgrounds
Example	/api/images/backgrounds
Access	EVERYONE

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
size	text	no	Image size, allowed values: thumbnail, medium, large. Medium by default.

Response

            
                {
                    "items_total": 5,
                    "items": [
                        {
                            "name": "1",
                            "image": "http://apidev.homeescape.com/uploads/images/backgrounds/medium/1.jpg"
                        },
                        {
                            "name": "2",
                            "image": "http://apidev.homeescape.com/uploads/images/backgrounds/medium/2.jpg"
                        } 
                        ...
                    ]
                }

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."
`SC006`	`User no authorization`	The token is not valid for use our API services	"Access Denied. Try contacting the support team."
`SC014`	`Expired token`	The token has expired	"Access Denied. Try contacting the support team."
`VID275`	`Invalid input for size`	Size is not in [thumbnail, medium, large]	[Call the API again using a valid value for the size]