| Name | Edit Property Places |
|---|---|
| Description | Edit interest places near of a property |
| Method | PUT |
| URL | /properties/{property}/places |
| Example | /api/properties/11111111/places | Access | OWNER, MANAGER |
| Authorization | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9... |
|---|---|
| Fields | Type | Required | Description |
|---|---|---|---|
| property | number | yes | Property id |
| car | number | no | 0 - Necessary, 1 - Not necessary, 2 - Recommended |
| airport | text | no | Name of the nearby airport |
| airport_distance | number | no | If airport have value, airport_distance is required |
| airport_distance_unit | number | no | If airport have value, airport_distance_unit is required, value: 0 - miles, 1 - kilometers, 2 - meters |
| beach | text | no | Name of the nearby beach |
| beach_distance | number | no | If beach have value, beach_distance is required |
| beach_distance_unit | number | no | If beach have value, beach_distance_unit is required, value: 0 - miles, 1 - kilometers, 2 - meters |
| ferry | text | no | Name of the nearby ferry station |
| ferry_distance | number | no | If ferry have value, ferry_distance is required |
| ferry_distance_unit | number | no | If ferry have value, ferry_distance_unit is required, value: 0 - miles, 1 - kilometers, 2 - meters |
| train | text | no | Name of the nearby train station |
| train_distance | number | no | If train have value, train_distance is required |
| train_distance_unit | number | no | If train have value, train_distance_unit is required, value: 0 - miles, 1 - kilometers, 2 - meters |
| highway | text | no | Name of the nearby highway |
| highway_distance | number | no | If airport highway value, highway_distance is required |
| highway_distance_unit | number | no | If highway have value, highway_distance_unit is required, value: 0 - miles, 1 - kilometers, 2 - meters |
| bar | text | no | Name of the nearby bar |
| bar_distance | number | no | If bar have value, bar_distance is required |
| bar_distance_unit | number | no | If bar have value, bar_distance_unit is required, value: 0 - miles, 1 - kilometers, 2 - meters |
| ski | text | no | Name of the nearby ski |
| ski_distance | number | no | If ski have value, ski_distance is required |
| ski_distance_unit | number | no | If ski have value, ski_distance_unit is required, value: 0 - miles, 1 - kilometers, 2 - meters |
| golf | text | no | Name of the nearby golf club |
| golf_distance | number | no | If golf have value, airport_distance is required |
| golf_distance_unit | number | no | If golf have value, golf_distance_unit is required, value: 0 - miles, 1 - kilometers, 2 - meters |
| restaurant | text | no | Name of the nearby restaurant |
| restaurant_distance | number | no | If restaurant have value, airport_distance is required |
| restaurant_distance_unit | number | no | If restaurant have value, restaurant_distance_unit is required, value: 0 - miles, 1 - kilometers, 2 - meters |
{
"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 that user |
The user logged in is not the property's owner | "Sorry, you do not have access to that property!" |
R000 |
Fail |
The property places wasn't updated | |
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] |
VID157 |
Invalid input for car |
Car is not in [0, 1, 2] | "Please enter a valid address" |
VID158 |
Invalid input for name of [place] |
Name of [place] has only characters not allowed | "Please enter a valid place name" |
VID159 |
Invalid input for distance value in [place] |
[place]_distance is not a number | "Distance must have only number" |
VID160 |
Invalid input for distance unit in [place] |
[place]_distance_unit is not a number | [Call the API again using a valid value for distance_unit] |