Skip to content

Query AOI With Order Count ​

API Information ​

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

Request Headers ​

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

Request Body Structure ​

None required.

Request Body Example ​

json
{}

Response Body Structure ​

CommonResponse Object ​

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataAoiOrderCountRespResponse data

AoiOrderCountResp Object ​

FieldTypeDescription
contentList<AoiOrderCountRespItem>AOI list with order count

AoiOrderCountRespItem Object ​

FieldTypeDescription
idLongAOI ID
nameStringAOI name
geoAoiStringAOI geometry (EWKT)
areaStringAOI area
lngLatStringAOI longitude and latitude
isGroupIntegerGroup flag
parentIdLongParent group ID
orderCountLongBound order count

Response Examples ​

Success Response ​

json
{
  "code": 200,
  "message": "success",
  "data": {
    "content": [
      {
        "id": 1001,
        "name": "AOI-1",
        "geoAoi": "POLYGON((...))",
        "area": "120.5",
        "lngLat": "24.3172°N 54.5365°E",
        "isGroup": 0,
        "parentId": 1000,
        "orderCount": 3
      }
    ]
  }
}

Failure Response ​

json
{
  "code": 400,
  "message": "Invalid parameters",
  "data": null
}

Error Code Description ​

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions ​

  1. This API is used to query AOI list with bound order count for current user.
  2. User authentication is required.
  3. Returns all AOIs without pagination.

Notes ​

  • orderCount is the number of orders associated with each AOI.