ロケーションの照会

Classic/VPC環境で利用できます。

e-mapまたはロボットマップ変換結果が存在するロケーションリストを照会します。レスポンス結果は Taskの種類によって異なります。emapperの場合、変換結果がある最上位ロケーションが1件返され、robot-mapの場合はロボットマップ結果が存在する フロア(floor)単位ロケーション リストが返されます。

事前段階

Map Data - ロケーション照会 APIを使用するための事前段階は次の通りです。

1. e-mapの作成またはロボットマップの作成

コンソールで、対象の最上位ロケーションに対して e-mapの作成またはロボットマップの作成を実行し、成功の状態になるまで完了させます。実行方法の詳細は、ARC eyeご利用ガイドをご参照ください。

2. Secret Keyの発行

NAVERクラウドプラットフォームコンソールの Menu > Services > Digital Twin > ARC eye > Visual Localization > Data Managementメニューで、Emapperまたは RobotMapタスク詳細にて Secret Keyの [作成] ボタンをクリックし、Map Data専用の Secret Keyを発行します。詳細な方法は、ARC eyeご利用ガイドをご参照ください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

ARC eye APIで共通して使用されるヘッダの詳細は、ARC eyeのリクエストヘッダをご参照ください。

リクエストパス変数

リクエストパス変数の説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

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

レスポンス

レスポンス形式を説明します。

レスポンスボディ(成功)

照会に成功した場合のレスポンスボディの説明は次の通りです。

locations

locationsの説明は次の通りです。

レスポンス例

レスポンスのサンプルコードは次の通りです。

成功(emapper)

emapperの呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

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

成功(robot-map)

robot-map呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

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