Cancel projects
Cancel certain projects.
For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The
sessionId in the response is your session token. Use this token in all the other calls that you make.
Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to and then select your user type.
API call
<protocol>://<ws-host>:<ws-port>/ws-api/v1/projects/cancel?token=<sessionId>
Details
- POST method
- Content-Type in the header:
application/json - Mandatory parameters:
- the session token (as a query string parameter or as a key-value pair in the header)
- the ID of the project that you want to cancel (in the JSON body)
- a comment (in the JSON body)
Request body example
Response
Error messages
| Message | Status code |
|---|---|
| Project Id is not valid (If the ID of the project is not a valid number.) | 400 Bad Request |
| Project is inactive (If the project was already canceled.) | 400 Bad Request |
| Not valid JSON body sent | 400 Bad Request |
| Field comment not sent | 400 Bad Request |
| No session token provided or invalid token | 401 Unauthorized |