List Maintenance Areas
List maintenance areas on a map by filter criteria with pagination.
Endpoint Information
Section titled “Endpoint Information”- Name: List maintenance areas
- Description: Returns maintenance areas matching the supplied filters in pages.
- Method:
POST - Path:
remoteApi/maintainAreaPage - Login required: No
- Permission required: Yes
Request Parameters
Section titled “Request Parameters”-
dogCode·String· OptionalRobot code
Example:123 -
maintainAreaCode·String· OptionalMaintenance area code
-
repairDesc·String· OptionalMaintenance area name or description
-
startTime·String· OptionalStart time
Example:yyyy-MM-dd HH:mm:ss -
endTime·String· OptionalEnd time
Example:yyyy-MM-dd HH:mm:ss -
issued·Integer· OptionalIssue status:
0not issued,1issued -
floor·String· OptionalFloor
-
pageNo·Integer· OptionalPage number
-
pageSize·Integer· OptionalPage size
Request Example
Section titled “Request Example”{ "dogCode": "DOG_001", "maintainAreaCode": "MA_20260123_001", "repairDesc": "First-floor east equipment maintenance area", "startTime": "2025-10-11 00:00:00", "endTime": "2026-10-12 00:00:00", "issued": 0, "floor": "1F", "pageNo": 1, "pageSize": 2}Response
Section titled “Response”| Field | Type | Example | Description |
|---|---|---|---|
| maintainAreaCode | String | 1977675229697835008 | Maintenance area code |
| startX | String | -60.75204918032773 | Start point x-coordinate |
| startY | String | 368.10830170115787 | Start point y-coordinate |
| endX | String | 76.99590163934431 | End point x-coordinate |
| endY | String | 184.90256007436358 | End point y-coordinate |
| startTime | String | Maintenance start date (yyyy-MM-dd) | |
| endTime | String | Maintenance end date (yyyy-MM-dd) | |
| repairDesc | String | test | Maintenance area description |
| dogCode | String | 1 | Associated robot code |
| issued | Integer | 0 | Issue status: 0 not issued, 1 issued |
| pointCodes | String | Associated point codes | |
| pointCount | Integer | Number of points | |
| floor | String | Floor | |
| mode | Integer | Area definition mode: 1 bounding box, 2 points |
Response Example
Section titled “Response Example”{ "success": true, "code": 200, "msg": "Operation succeeded", "data": { "records": [ { "maintainAreaCode": "MA_20260123_001", "startX": "120.35", "startY": "45.80", "endX": "180.60", "endY": "90.20", "startTime": "2026-01-23", "endTime": "2026-01-23", "repairDesc": "First-floor east equipment maintenance area", "dogCode": "DOG_001", "issued": 0, "pointCodes": "P001,P002,P003", "pointCount": 3, "floor": "1F", "mode": 1 } ], "total": 1, "size": 2, "current": 1, "pages": 1 }}Error Codes
Section titled “Error Codes”| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 401 | Unauthorized |
| 403 | Access denied |
| 404 | Resource not found |
| 500 | Internal server error |