location/update-area
エリア更新
エリアグループIDとエリア情報を更新します。 areaName, areaShape, extraは置き換えとなります。
その他の共通仕様は位置情報収集基盤API共通仕様をご確認ください。
HTTP request method
POST
ContentType
application/x-www-form-urlencoded
Parameters
| 名前 | 説明 |
|---|---|
| request_data *required string |
リクエストデータ jsonデータ。詳細は下記参照 |
request_dataのjsonパラメータ
| 名前 | 説明 |
|---|---|
| areaGroupId *required string |
エリアグループID エリアグループのユニークなID。 半角英数字とハイフン、アンダーバーのみ使用可能です。 最小文字数4文字 最大文字数40文字 |
| areaId *required string |
エリアID エリアのユニークなID。 半角英数字とハイフン、アンダーバーのみ使用可能です。 最小文字数4文字 最大文字数40文字 |
| areaName
string |
エリア名称 設定した値は取得時に検索条件として指定ができます。 以下の特殊記号を使用する場合はバックスラッシュでエスケープしてください。 ＜特殊記号＞ ・ \" (ダブルコーテーション) ・ \\ (バックスラッシュ) ・ \b (バックスペース) ・ \f (改ページ) ・ \n (改行) ・ \r (キャリッジリターン) ・ \t (タブ) 例："テストデータ\01" → \"テストデータ\\01\" |
| areaShape *required GeoJSON |
エリア形状 GeoJSON形式のポリゴンか円の形状データ。円のGeoJSONは標準のフォーマットでは存在しないためExampleのareaShapeの例を参照してください。ポリゴンの場合、頂点数が10より多いとエラーが発生します。 |
| extra
string |
付加情報 エリア情報に付加したい情報 特殊記号を使用する場合は「areaName（エリア名称）」と同様に特殊記号をバックスラッシュ（\）でエスケープしてください。 |
Responses
Media type:application/json
| キー名 | 説明 | |||
|---|---|---|---|---|
| response | status | returnCode integer |
処理結果コード 0:正常 0以外:エラーコード |
|
| errorMessage string |
エラーメッセージ returnCodeが0以外の場合に出力 |
|||
Example
https://[domain]/location/update-area
・request_data例
{
"areaGroupId": "test_area_group_001",
"areaId": "test_area_001",
"areaName": "テストエリア名称",
"areaShape": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"radius": 100
},
"extra": "\\テスト付加情報\\\fデータ詳細"
}
}
円の形状
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
}
}
}