| Name | Edit Property Kitchens |
|---|---|
| Description | Edit the kitchen's amenities of a property |
| Method | PUT |
| URL | /properties/{property}/kitchens |
| Example | /api/properties/11111111/kitchens | Access | OWNER, MANAGER |
| Authorization | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9... |
|---|---|
| Fields | Type | Required | Description |
|---|---|---|---|
| property | number | yes | Property id. |
| kitchen | bool | no | If property has kitchen. |
| kitchen_desc | text | no | Description about kitchen, only fill when kitchen is true. |
| kitchen_utensils | bool | no | If property has kitchen utensils. |
| kitchen_utensils_desc | text | no | Description about kitchen utensils, only fill when kitchen_utensils is true. |
| refrigerator | bool | no | If property has refrigerator. |
| refrigerator_desc | text | no | Description about refrigerator, only fill when refrigerator is true. |
| blender | bool | no | If property has blender. |
| blender_desc | text | no | Description about blender, only fill when blender is true. |
| freezer | bool | no | If property has freezer. |
| freezer_desc | text | no | Description about freezer, only fill when freezer is true. |
| microwave | bool | no | If property has microwave. |
| microwave_desc | text | no | Description about microwave, only fill when microwave is true. |
| dishwasher | bool | no | If property has dishwasher. |
| dishwasher_desc | text | no | Description about dishwasher, only fill when dishwasher is true. |
| toaster | bool | no | If property has toaster. |
| toaster_desc | text | no | Description about toaster, only fill when toaster is true. |
| coffee_maker | bool | no | If property has coffee maker. |
| coffee_maker_desc | text | no | Description about coffee maker, only fill when coffee_maker is true. |
| stove | bool | no | If property has stove. |
| stove_desc | text | no | Description about stove, only fill when stove is true. |
| oven | bool | no | If property has oven. |
| oven_desc | text | no | Description about oven, only fill when oven is true. |
| garbage_disposal | bool | no | If property has garbage disposal. |
| garbage_disposal_desc | text | no | Description about garbage disposal, only fill when garbage_disposal is true. |
| grill | bool | no | If property has grill. |
| grill_desc | text | no | Description about grill, only fill when grill is true. |
{
"code": R111,
"message": "Success"
}
| 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!" |
EC014 |
Property doesn't belong to the user |
The user logged in is not the property's owner | "Sorry, you do not have access to that property!" |
R000 |
Fail |
The kitchen amenities were not updated | |
R111 |
Success |
The operation was successful | [Update the kitchen amenities] |
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] |
VID184 |
Invalid input for amenity |
The kitchen amenity is not in [0, 1] | [Call the API again using a valid value for the kitchen amenity] |
VID185 |
Invalid input for amenity description |
The kitchen amenity description has more than 200 characters or it only has characters not allowed | "Please enter a valid description" |