Get location

Available in Classic and VPC

Get the list of locations for which e-map or robot map conversion results exist. The response result varies depending on the task type. For emapper, a single top-level location with conversion results is returned, while for robot-map, the list of floor-level locations for which robot map results exist is returned.

Preliminary steps

The preliminary steps for using Map Data - Get location API are as follows:

1. Create e-map or robot map

In the console, perform the e-map creation or robot map creation task for the target top-level location and complete it until it reaches the Success status. For more information, see the ARC eye user guide.

2. Issue secret key

In the NAVER Cloud Platform console, go to Menu > Services > Digital Twin > ARC eye > Visual Localization > Data Management and click [Create] of Secret Key in the task details of the target Emapper or RobotMap to obtain a secret key dedicated to Map Data. For more information, see the ARC eye user guide.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/map-data/v1/{projectId}/{signature}/{task}/locations

Note

It calls by replacing the final path /download-urls of the URL from the Get download URL API under Common ARC eye settings > APIURL with /locations.

Request headers

For information about the headers common to all ARC eye APIs, see ARC eye request headers.

Request path variables

The following describes the request path variables.

Field	Type	Required	Description
`projectId`	Number	Required	Project ID Available on the download URL query page
`signature`	String	Required	Project signature value Available on the download URL query page
`task`	String	Required	Target task type `emapper` \| `robot-map` Available on the download URL query page

Request example

The request example is as follows:

curl --location --request GET '{InvokeURL}' \
--header 'X-ARCEYE-SECRET: {SecretKey}'

Response

This section describes the response format.

Response body (success)

The following describes the response body when the query is successful.

Field	Type	Required	Description
`locations`	Array	-	List of locations where results exist: locations

`locations`

The following describes locations.

Field	Type	Required	Description
`locationId`	Number	-	Location ID
`locationName`	String	-	Location name
`locationNamePath`	String	-	A value formed by concatenating the names of the locations from the top-level location down to the current location using `_` For `emapper`, this is the same as the top-level location name.

Response example

The response example is as follows:

Succeeded(`emapper`)

The following is a sample response upon a successful emapper call.

{
  "locations": [
    {
      "locationId": 1001,
      "locationName": "Office",
      "locationNamePath": "Office"
    }
  ]
}

Succeeded(`robot-map`)

The following is a sample response upon a successful robot-map call.

{
  "locations": [
    {
      "locationId": 2001,
      "locationName": "1F",
      "locationNamePath": "Office_1F"
    },
    {
      "locationId": 2002,
      "locationName": "B1F",
      "locationNamePath": "Office_B1F"
    }
  ]
}