location/delete-area

エリア削除

エリアグループIDとエリア情報を削除します。25個まで一度に削除できます。存在しないエリアIDを削除しようとした場合はエラーが発生します。

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

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

HTTP request method

POST

ContentType

application/x-www-form-urlencoded

Parameters

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

request_dataのjsonパラメータ

名前 説明
areas
*required
array[object]		 エリア配列
エリアの配列
最小値 1
最大値 25
areaGroupId
*required
string		 エリアグループID
エリアのユニークなID。
半角英数字とハイフン、アンダーバーのみ使用可能です。
最小文字数4文字
最大文字数40文字
areaId
*required
GeoJSON		 エリアID
エリアのユニークなID。
半角英数字とハイフン、アンダーバーのみ使用可能です。
最小文字数4文字
最大文字数40文字

Responses

Media type:application/json

キー名 説明
response status returnCode
integer		 処理結果コード
0:正常
0以外:エラーコード
errorMessage
string		 エラーメッセージ
returnCodeが0以外の場合に出力

Example

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

・request_data例
{
    "areas": [
        {
            "areaGroupId": "test_area_group_001",
            "areaId": "test_area_001",
        },
        {
            "areaGroupId": "test_area_group_002",
            "areaId": "test_area_002",
        }
    ]
}
レスポンス 
{
    "response": {
        "status": {
            "returnCode": 0
        }
    }
}