location/search-area

エリア検索

エリア情報を検索します。下記の検索が可能です。

  • エリアグループIDを検索条件にして前方一致でエリアを検索
  • エリアIDを検索条件にして前方一致でエリアを検索
  • エリアグループIDとエリアIDを検索条件に設定せずにすべてのエリアを検索

その他の共通仕様は位置情報収集基盤API共通仕様をご確認ください。

https://[domain]/location/search-area

HTTP request method

POST

ContentType

application/x-www-form-urlencoded

Parameters

名前 説明
request_data
*required
string		 リクエストデータ
jsonデータ。詳細は下記参照

request_dataのjsonパラメータ

名前 説明
areaGroupId
string		 エリアグループID
エリアグループのユニークなID。
半角英数字とハイフン、アンダーバーのみ使用可能です。
最大文字数40文字
areaId
string		 エリアID
エリアのユニークなID。
半角英数字とハイフン、アンダーバーのみ使用可能です。
最大文字数40文字
sort
string
default areaGroup		 エリア形状
areaGroup:エリアグループIDソート
area:エリアIDソート
order
string
default asc		 エリア形状
ソート順。
asc:昇順
desc:降順。
limit
integer
default 100		 取得件数
取得開始位置を基準とした取得件数。
最小値 1
最大値 1000
offset
integer
default 1		 取得開始位置
絞込み後のデータに対する取得開始位置。
最小値 1
最大値 100,000,000,000

Responses

Media type:application/json

キー名 説明
response status returnCode
integer		 処理結果コード
0:正常
0以外:エラーコード
errorMessage
string		 エラーメッセージ
returnCodeが0以外の場合に出力
result limitAfterCount
integer		 limit後件数
limitによる絞り込み後の件数。areasの個数と同数。
limitBeforeCount
integer		 limit前件数
limitによる絞り込み前の件数。
limitとoffsetを指定しなかった場合に取得できるデータの総件数と同数。
areas
array[object]		 エリア配列
最小値 0
最大値 1000
areaGroupId
string		 エリアグループID
エリアグループのユニークなID。
半角英数字とハイフン、アンダーバーのみ使用可能です。
最小文字数4文字
最大文字数40文字
areaId
string		 エリアID
エリアのユニークなID。
半角英数字とハイフン、アンダーバーのみ使用可能です。
最小文字数4文字
最大文字数40文字
areaShape
GeoJSON		 エリア形状
GeoJSON形式のポリゴンか円の形状データ。円のGeoJSONは標準のフォーマットでは存在しないためExampleのareaShapeの例を参照してください。

Example

リクエストURL 
https://[domain]/location/search-area

・request_data例
{
    "areaGroupId": "test_area_group",
    "areaId": "test_area_group_001",
    "sort": "areaGroup",
    "order": "asc",
    "limit": 100,
    "offset": 1
}
areaShapeの例
円の形状
GeoJSONの標準仕様には円を表す形式がないためGeoJSONのpropertiesを利用して円を表します。下記のようにpropertiesの中にradius(半径)をメートル単位で記述してください。geometryのtypeはPointにしてください。coordinatesには経度、緯度の順番で座標を入れることに注意してください。 
{
    "type": "Feature",
    "geometry": {
        "type": "Point",
        "coordinates": [-122.126986, 47.639754]
    },
    "properties": {
        "radius": 100
    }
}
 ポリゴンの形状
ポリゴンはGeoJSONの標準仕様の形式で設定可能です。typeはPolygon。MultiPolygonは対象外です。ドーナツ型などの内側に穴がある形状も対象外です。1点目の座標と最終の座標は同じ座標にしてください。 coordinatesには経度、緯度の順番で座標を入れることに注意してください。 
{
    "type": "Feature",
    "geometry": {
        "type": "Polygon",
        "coordinates": [[[5,25],[14,25],[14,29],[5,29],[5,25]]]
    }
}
 レスポンス 
{
    "response": {
        "status": {
            "returnCode": 0
        },
        "result": {
            "limitAfterCount": 2,
            "limitBeforeCount": 2,
            "areas": [
                {
                    "areaGroupId": "test_area_group_001",
                    "areaId": "test_area_group_001",
                    "areaShape": {
                        "type": "Feature",
                        "geometry": {
                            "type": "Point",
                            "coordinates": [
                                -122.126986,
                                47.639754
                            ]
                        },
                        "properties": {
                            "radius": 100
                        }
                    }
                },
                {
                    "areaGroupId": "test_area_group_002",
                    "areaId": "test_area_group_002",
                    "areaShape": {
                        "type": "Feature",
                        "geometry": {
                            "type": "Polygon",
                            "coordinates": [[[5,25],[14,25],[14,29],[5,29],[5,25]]]
                        }
                    }
                }
            ]
        }
    }
}