Service

Name Delete Property Rate
Description Delete a rate of a property
Method DELETE
URL /properties/{property}/rates/{rate}
Example /api/properties/11111111/rates/12345
Access OWNER, MANAGER

HTTP Headers

Authorization eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields Type Required Description
property number yes Property id
rate number yes Rate id

Response

            
                {
                    "code": R111,
                    "message": "Success"
                }
            
            

Response Codes

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!"
EC013 Rate not found Rate id doesn't match our records "Sorry, We couldn't find that rate!"
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!"
EC018 Rate does not belong to the user Rate id does not belong to the user "Sorry, you do not have access to that rate!"
EC023 Standard rate can not be deleted You are trying to deleted the Standard Rate [Don't show the option to delete the standard rate]
R000 Fail The rate wasn't deleted
R111 Success The operation was successful [Remove the rate from the list]
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]
VID214 Invalid input for period Rate id is not a number [Call the API again using a valid value for rate id]