Service

Name Deactivate Property
Description Deactivate a property
Method PATCH
URL /properties/{property}
Example /api/properties/11111111
Access OWNER, MANAGER

HTTP Headers

Authorization eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields Type Required Description
property number yes Id of the property.
message text yes The reason why to deactivate the property.

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!"
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!"
EC019 The property is not active The property is inactive [Don't show the option of deactivate for inactive properties] - "The property is inactive"
EC011 Status not found Status: "pending" doesn't match our records "Oops! Looks like we hit a snag. Try closing the app and reopening it."
EC035 Ticket not found Ticket Type: "deactivation" doesn't match our records "Oops! Looks like we hit a snag. Try closing the app and reopening it."
R000 Fail The property wasn't deactivated
R111 Success The operation was successful "Thank you for contacting us, one of our representatives will contact you shortly."
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]
VID150 Invalid input for message Message is empty or it has only characters not allowed (" ", ', ’, ‘, ’, ", &, \, <, >, --) "Please fill out this field" - "Please enter a valid text for Message"