Photos

This endpoint is used to retrieve all photos associated with a given room.

Endpoint

Method	URI	Headers
GET	/api/rooms/{room}/photos	Authorization: Bearer <token> Accept: application/json

Route Params

Param	Description	Type	Required
{room}	The ID of a given room.	Integer	Yes

Request & Response Examples

Successful Response

200

Example request

curl \
  --request GET \
  --url https://api.luxstay.com/api/rooms/10000/photos \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>'

1
2
3
4
5

Example response

{
    "data": [
        {
            "id": 4400,
            "name": "living-room.jpg",
            "highlights": "",
            "featured": true,
            "slide": true,
            "order": 0,
            "caption": "<content>",
            "photo_url": "https://image.luxstay.com/rooms/10000/large/living-room.jpg?w=1200&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq",
            "thumbnail": "https://image.luxstay.com/rooms/10000/thumbnail/living-room.jpg?w=250&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq"
        },
        {
            "id": 4401,
            "name": "bathroom.jpg",
            "highlights": "",
            "featured": false,
            "slide": true,
            "order": 0,
            "caption": "<content>",
            "photo_url": "https://image.luxstay.com/rooms/10000/large/bathroom.jpg?w=1200&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq",
            "thumbnail": "https://image.luxstay.com/rooms/10000/thumbnail/bathroom.jpg?w=250&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq"
        },
        {
            "id": 4402,
            "name": "bedroom.jpg",
            "highlights": "",
            "featured": false,
            "slide": true,
            "order": 0,
            "caption": "<content>",
            "photo_url": "https://image.luxstay.com/rooms/10000/large/bedroom.jpg?w=1200&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq",
            "thumbnail": "https://image.luxstay.com/rooms/10000/thumbnail/bedroom.jpg?w=250&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq"
        },
        {
            "id": 4403,
            "name": "kitchen.jpg",
            "highlights": "",
            "featured": false,
            "slide": true,
            "order": 0,
            "caption": "<content>",
            "photo_url": "https://image.luxstay.com/rooms/10000/large/kitchen.jpg?w=1200&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq",
            "thumbnail": "https://image.luxstay.com/rooms/10000/thumbnail/kitchen.jpg?w=250&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq"
        },
        {
            "id": 4404,
            "name": "balcony.jpg",
            "highlights": "",
            "featured": false,
            "slide": false,
            "order": 0,
            "caption": "<content>",
            "photo_url": "https://image.luxstay.com/rooms/10000/large/balcony.jpg?w=1200&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq",
            "thumbnail": "https://image.luxstay.com/rooms/10000/thumbnail/balcony.jpg?w=250&fit=crop&v=RGb88hdhC0QcgspvCupZ0CQsq"
        }
    ],
    "meta": {
        "pagination": {
            "total": 5,
            "count": 5,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

Error Response

401

Reason invalid access token

Example response

{
    "message": "Unauthenticated."
}

1
2
3

403

Reason cannot access room photos

Example response

{
    "message": "You are not allowed to access or change information associated with this room."
}

1
2
3

404

Reason cannot find the given room

Example response

{
    "message": "Cannot find the given room"
}

1
2
3

# Photos

# Endpoint

# Route Params

# Request & Response Examples

# Successful Response

# 200

# Error Response

# 401

# 403

# 404

Photos

Endpoint

Route Params

Request & Response Examples

Successful Response

200

Error Response

401

403

404