Cancel Project

Back to JEA API docs

Use the Cancel Project command to cancel the exploration process of an existing project. No stats on project completion will be carried out if a project is cancelled. This is the main difference between cancelling and terminating a project.

A valid JWT token must be included in the header, otherwise, the transaction will be rejected with an HTTP 401 Unauthorized error code. The result of the operation will be reported in an Engine Response object.

• Method: GET
• Target: https://api.ensims.com/jea_web/api/cancel/<projectId>
• Header: Authorization “Bearer <existing JWT>”
• Body: none
• Success: Engine Response
• Error: HTTP 401 - Unauthorized

Result of the operation is returned as an engine response object as seen in the example here:

{
  "description": "Cancel flag set for project circle.",
  "ok": true
}

If the project is not accessible, the response may be:

{
  "description": "Project \"circle\" does not exist or not accessible to user \"yi@jeplus.org\".",
  "ok": false
}

To send the Cancel Project command using curl:

curl -b cookies  https://api.ensims.com/jea_web/api/cancel/circle

On successful operation, an engine response object is returned. If the existing JWT is invalid, an HTTP 401 Unauthorized code will be returned.

Make sure Requests is correctly installed in your Python environment, and run the following the lines:

import requests

# Cancel 'circle' project 

# Make a request with the stored cookies from the log on transaction
r = requests.get('https://api.ensims.com/jea_web/api/cancel/circle', cookies=cookies)
  
r.json()