Name | Edit Property Standard Rate |
---|---|
Description | Edit standard rate of a property |
Method | PUT |
URL | /properties/{property}/rates/standard |
Example | /api/properties/11111111/rates/standard | Access | OWNER, MANAGER |
Authorization | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9... |
---|---|
Fields | Type | Required | Description |
---|---|---|---|
property | number | yes | Property id |
minimum_stay | number | yes | Minimum number of days. |
nightly | number | yes | Price per night |
weekly | number | no | Price per week |
monthly | number | no | Price per month |
weekend_charge | bool | no | Charge for weekend nights |
weekend_price | number | no | If weekend_nights_charge is true, you need to specified the value |
weekend_days | array | no | If weekend_nights_charge is true, you need to specified the value |
guest_fee | bool | no | Applies fee for guest |
guest_fee_price | number | no | If guest_fee is true, this field is required |
guests_quantity | number | no | If guest_fee is true, this field is required |
notes | text | no | Additional notes to specified any things |
Fields | Type | Required | Description |
---|---|---|---|
[thursday] | bool | yes | If charge applied Thursday. |
[friday] | bool | yes | If charge applied Friday. |
[saturday] | bool | yes | If charge applied Saturday. |
[sunday] | bool | yes | If charge applied Sunday. |
{
"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 standard rate 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] |
VID169 |
Invalid input for rate minimum stay |
Minimum_stay is not a number between 0-180 | "Please select an item from the list" |
VID170 |
Invalid input for rate price nightly |
Nightly is not a number | Nightly must be a number |
VID171 |
Invalid input for rate price weekly |
Weekly is not a number | Weekly must be a number |
VID172 |
Invalid input for rate price monthly |
Monthly is not a number | Monthly must be a number |
VID173 |
Invalid input for rate weekend_charge |
Weekend_charge is not in [0, 1] | [Call the API again using a valid value for weekend_charge] |
VID174 |
Invalid input for rate weekend_price |
Weekend_price is not a number | Weekend nights price must be a number |
VID175 |
Invalid input for rate weekend_days |
Weekend_days is not an array of 4 item or some items are not in [0, 1] | [Call the API again using a valid value for weekend_days] |
VID176 |
Invalid input for rate guest_fee |
Guest_fee is not in [0, 1] | [Call the API again using a valid value for guest_fee] |
VID177 |
Invalid input for guest_price |
Guest_price is not a number | Guest fee must be a number |
VID178 |
Invalid input for guest_quantity |
Guest_quantity is not a number | "Please select an item from the list" |
VID183 |
Invalid input for notes |
Notes has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --) | "Please enter a valid text for Notes" |