Get Docks

Get dock information from a specified robot map.

Endpoint Information

• Name: Get docks
• Description: Returns the docks associated with a robot.
• Method: POST
• Path: remoteApi/dockList
• Login required: No
• Permission required: Yes

---

Request Parameters

Parameter	Type	Required	Example	Description
dogCode	String	Yes	123	Robot code

Example:

{
  "dogCode": "DOG2011258510273380352"
}

Response

Field	Type	Example	Description
dockCode	String	a001_2	Dock code
dogCode	String	1	Robot code
edgeCode	String	a001_7	Code of the associated edge
floor	String	a001	Floor
coordinate	String	-263.489000,527.393400,-31.563900	Dock coordinates in x,y,z format, in cm
priority	String		Dock priority
dockName	String		Dock name

Example:

{
  "success": true,
  "code": 200,
  "msg": "Operation succeeded",
  "data": [
    {
      "dockCode": "A1_1",
      "dogCode": "DOG2011258510273380352",
      "edgeCode": "A1_3",
      "floor": "A1",
      "coordinate": "-0.022400,11.025300,0.000000",
      "priority": null,
      "dockName": null
    },
    {
      "dockCode": "A1_2",
      "dogCode": "DOG2011258510273380352",
      "edgeCode": "A1_4",
      "floor": "A1",
      "coordinate": "-290.778800,20.984300,0.000000",
      "priority": null,
      "dockName": null
    },
    {
      "dockCode": "A1_3",
      "dogCode": "DOG2011258510273380352",
      "edgeCode": "A1_4",
      "floor": "A1",
      "coordinate": "-941.101100,48.322300,0.000000",
      "priority": null,
      "dockName": null
    }
  ]
}

Error Codes

Code	Description
400	Invalid parameters
401	Unauthorized
403	Access denied
404	Resource not found
500	Internal server error