Appearance
Delete AOI API
API Information
- Request Path:
/aoi/delete/aoi - Request Method:
POST - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
| Content-Type | String | Yes | Must be set to application/json |
Request Body Structure
DeleteAoiReq Object
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| id | Long | Yes | AOI ID | Must be valid AOI ID |
Request Body Example
json
{
"id": 12345
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | Boolean | Deletion 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 Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 404 | AOI not found |
| 500 | Server internal error |
Usage Instructions
- This API is used to delete an Area of Interest (AOI)
- User authentication is required
- AOI ID must be provided
- Only AOI owners can delete their AOIs
- 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