Map

APIs for retrieving map vertex and point information.

GetMap

Returns map vertex/point information including positions, docking configurations, and operational metadata.

GET /map/getMapVertexes/{map_id}

Request

Field	Message Type	Description
map_id	int32	Map ID to query. Passed as a path parameter.

JSON Request Example

JSON

  {}

Note

The map_id is passed as a URL path parameter.

Response

Field	Message Type	Description
vertexes	repeated VertexInfo	List of map vertex/point information.

JSON Response Example

JSON

  {
    "vertexes": [
      {
        "id": 1,
        "code": "PICKUP_01",
        "alias": "Pickup Station 1",
        "description": "Main pickup point",
        "x": 10.5,
        "y": 20.3,
        "theta": 0.0,
        "type": 1,
        "loading": 0,
        "dockingDirection": 2,
        "dockingX": 0.0,
        "dockingY": 0.0,
        "dockingTheta": 0.0,
        "outboundX": 0.0,
        "outboundY": 0.0,
        "outboundTheta": 0.0,
        "forceLoad": false,
        "relocThreshold": 0,
        "forbiddenBack": 0,
        "allowPark": 1,
        "extend": "{}",
        "mapId": 1
      },
      {
        "id": 2,
        "code": "CHARGE_01",
        "alias": "Charging Station",
        "description": "",
        "x": 5.0,
        "y": 5.0,
        "theta": 3.14,
        "type": 2,
        "loading": 0,
        "dockingDirection": 3,
        "dockingX": 0.1,
        "dockingY": 0.0,
        "dockingTheta": 0.0,
        "outboundX": -0.5,
        "outboundY": 0.0,
        "outboundTheta": 0.0,
        "forceLoad": false,
        "relocThreshold": 100,
        "forbiddenBack": 0,
        "allowPark": 0,
        "extend": "{}",
        "mapId": 1
      }
    ]
  }