Summary
Requirements
All API calls require a dedicated JSON Web Token (JWT). These are created when a user with a dedicated mobile resource logs in to the application. If you are using the API for programmatic queries, it is best to create a dedicated user for the JWT as this gets reset each time the user logs in.
Endpoint
/rest/rs/cancelAppointment/{jobRef}/{appointmentRef}
GET
Note: Appointment references can only be added through the addAppointment API
Cancels an appointment. Looks up the appointment to cancel by the Oneserve job reference and the appointment client reference.
Available Response Representations
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Appointment Cancelled | "Success" |
| 400 | Bad Request | Error |
| 401 | Unauthorized | Error |
| 403 | Forbidden | Error |
| 404 | Address Not Found | Error |
| 405 | Method Not Allowed | Error |
| 500 | Internal Server Error | Error |
Example success response
{
"result": "success",
"result_msg": ""
}
Troubleshooting
401 Unauthorized
Response
401 Unauthorized
Reason
This error occurs if the OS-REST-AUTH-TOKEN has not been provided, has expired, or does not exist in the system
Resolution
Verify your OS-REST-AUTH-TOKEN with support
403 Forbidden
Response
403 Forbidden
Reason
This error indicates that something is blocking your connection to the server
Resolution
Open a ticket with the support team with details of your connection so that your access can be verified
404 Not Found
Response
404 Not Found
Reason
This error could occur if the endpoint is not entered correctly or a non-existent client ID is passed in the request
Resolution
Verify the endpoint matches the value specified in this article. Check that the client ID exists in your Oneserve system.
405 Method Not Allowed
Response
405 Method Not Allowed
Reason
This error will occur if an unacceptable method has been used in the call such as POST or DELETE
Resolution
Ensure that you are using a GET call to these endpoints