Photos Modification

This endpoint is used to update (or upload) photos for a given room. Multiple files can be uploaded in a single request.

Endpoint

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

Data Params

Param Description Type Required
file An array of image files used for uploading process.
Supported mime types are JPG, PNG, and GIF.
Maximum size is 8MB.
Array Yes

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 POST \
  --url https://api.luxstay.com/api/rooms/10000/photos \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'photo[0]=/path/to/image/living-room.jpg' \
  --form 'photo[1]=/path/to/image/bathroom.jpg'
1
2
3
4
5
6
7
8

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"
        }
    ]
}
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

Error Response

400

Reason invalid uploaded files

Example response

{
    "message": "Cannot processing the uploaded files."
}
1
2
3

401

Reason invalid access token

Example response

{
    "message": "Unauthenticated."
}
1
2
3

403

Reason unauthorized to update photos of a given room

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
Last Updated: 11/18/2018, 9:11:26 AM