Skip to content

Delete AOI API ​

API Information ​

  • Request Path: /aoi/delete/aoi
  • Request Method: POST
  • Content-Type: application/json

Request Headers ​

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to application/json

Request Body Structure ​

DeleteAoiReq Object ​

FieldTypeRequiredDescriptionConstraints
idLongYesAOI IDMust be valid AOI ID

Request Body Example ​

json
{
  "id": 12345
}

Response Body Structure ​

CommonResponse Object ​

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataBooleanDeletion result, true indicates success

Response Examples ​

Success Response ​

json
{
  "code": 200,
  "message": "success",
  "data": true
}

Failure Response ​

json
{
  "code": 404,
  "message": "AOI not found",
  "data": false
}

Error Code Description ​

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
404AOI not found
500Server internal error

Usage Instructions ​

  1. This API is used to delete an Area of Interest (AOI)
  2. User authentication is required
  3. AOI ID must be provided
  4. Only AOI owners can delete their AOIs
  5. Returns boolean indicating deletion success

Notes ​

  • AOI ID is required and cannot be null
  • Deletion is permanent and cannot be undone
  • User authentication token must be included in request headers
  • Request body must be valid JSON format