Get Road Networks
Get road networks and related information from a specified robot map.
Endpoint Information
Section titled “Endpoint Information”- Name: Get road networks
- Description: Returns the road-network edges associated with a robot.
- Method:
POST - Path:
remoteApi/roadMapList - Login required: No
- Permission required: Yes
Request Parameters
Section titled “Request Parameters”| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| dogCode | String | Yes | 123 | Robot code |
Example:
{ "dogCode": "DOG2011258510273380352"}Response
Section titled “Response”| Field | Type | Example | Description |
|---|---|---|---|
| dogCode | String | 1 | Associated robot code |
| edgeCode | String | a001_3 | Edge code |
| edgeStartNode | String | a001_3 | Start node code |
| edgeEndNode | String | a001_4 | End node code |
| startCoordinate | String | -283.592000,468.701000,-31.600000 | Start coordinates in x,y,z format, in cm |
| endCoordinate | String | 5.846300,404.233100,-30.332300 | End coordinates in x,y,z format, in cm |
| controlPoint1 | String | -187.112600,447.211700,-30.188200 | First Bezier control point in x,y,z format, in cm |
| controlPoint2 | String | -90.633100,425.722400,-29.789300 | Second Bezier control point in x,y,z format, in cm |
| floor | String | a001 | Associated floor |
| moveDisable | Boolean | false | Whether navigation-target commands are disabled: true disabled, false enabled |
Example:
{ "success": true, "code": 200, "msg": "Operation succeeded", "data": [ { "dogCode": "DOG2011258510273380352", "edgeCode": "A1_3", "edgeStartNode": "A1_2", "edgeEndNode": "A1_1", "startCoordinate": "-151.144200,15.114400,0.000000", "endCoordinate": "156.789000,6.782200,0.000000", "controlPoint1": "-48.499800,12.337000,0.000000", "controlPoint2": "54.144600,9.559600,0.000000", "floor": "A1", "moveDisable": true }, { "dogCode": "DOG2011258510273380352", "edgeCode": "A1_4", "edgeStartNode": "A1_2", "edgeEndNode": "A1_6", "startCoordinate": "-151.144200,15.114400,0.000000", "endCoordinate": "-449.273000,27.647100,0.000000", "controlPoint1": "-250.520500,19.292000,0.000000", "controlPoint2": "-349.896700,23.469500,0.000000", "floor": "A1", "moveDisable": false }, { "dogCode": "DOG2011258510273380352", "edgeCode": "A1_5", "edgeStartNode": "A1_5", "edgeEndNode": "A1_4", "startCoordinate": "-833.206000,43.786700,0.000000", "endCoordinate": "-981.010000,50.000000,0.000000", "controlPoint1": "-882.474000,45.857800,0.000000", "controlPoint2": "-931.742000,47.928900,0.000000", "floor": "A1", "moveDisable": false }, { "dogCode": "DOG2011258510273380352", "edgeCode": "A1_6", "edgeStartNode": "A1_6", "edgeEndNode": "A1_5", "startCoordinate": "-449.273000,27.647100,0.000000", "endCoordinate": "-833.206000,43.786700,0.000000", "controlPoint1": "-577.250700,33.027000,0.000000", "controlPoint2": "-705.228300,38.406800,0.000000", "floor": "A1", "moveDisable": false }, { "dogCode": "DOG2011258510273380352", "edgeCode": "A1_7", "edgeStartNode": "A1_5", "edgeEndNode": "A1_7", "startCoordinate": "-833.206000,43.786700,0.000000", "endCoordinate": "-626.168800,98.281000,0.000000", "controlPoint1": "-764.193600,61.951500,0.000000", "controlPoint2": "-695.181200,80.116200,0.000000", "floor": "A1", "moveDisable": false }, { "dogCode": "DOG2011258510273380352", "edgeCode": "A1_8", "edgeStartNode": "A1_7", "edgeEndNode": "A1_6", "startCoordinate": "-626.168800,98.281000,0.000000", "endCoordinate": "-449.273000,27.647100,0.000000", "controlPoint1": "-567.203600,74.736300,0.000000", "controlPoint2": "-508.238300,51.191700,0.000000", "floor": "A1", "moveDisable": false } ]}Error Codes
Section titled “Error Codes”| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 401 | Unauthorized |
| 403 | Access denied |
| 404 | Resource not found |
| 500 | Internal server error |