location/entry-position

位置登録

端末の位置情報を非同期で登録します。
位置情報データの受け取りが完了し、内容に問題がないか入力値チェックをして問題がないと判断された時点でレスポンスを返却します。レスポンスが返却されてから、位置情報がデータベースに反映されるまで数秒のタイムラグが発生するため、すぐに位置情報の検索を行っても最新位置が取得できない可能性があることに注意してください。
蓄積された位置情報は一定間隔でS3にもファイル出力されます。位置情報の分析にはS3のファイルの利用を推奨します。
一つのリクエスト内に同一時刻の位置情報が存在した場合は、配列の後のデータのみ登録します。同じ端末の同時刻の位置情報が2つデータベース上に存在することはありません。別のリクエストで同時刻の位置情報を登録した場合でも、後のリクエストの情報で上書きを行います。
S3以外のデータは、データを保存しておく期間をサービス利用申請時に日数で指定可能です。データを登録してからデータ保存期間を過ぎたデータは、自動的に削除されます。保存期間を過ぎてからデータが削除されるまでは、タイムラグがありますのでご注意ください。
サービス利用中に途中でデータ保存期間を変更してもそれまでに登録したデータの保存期間は変更されませんのでご注意ください。

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

https://[domain]/location/entry-position

HTTP request method

POST

ContentType

application/x-www-form-urlencoded

Parameters

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

request_dataのjsonパラメータ

名前 説明
deviceId
*required
string		 端末ID
端末毎にユニークなID
半角英数字とハイフン、アンダーバーのみ使用可能です。
最小文字数4文字
最大文字数40文字
positions
*required
array[object]		 位置情報
位置情報の配列
最大1000件まで一括登録可能です。
isSearch
*required
boolean		 検索DB可能フラグ
検索可能な状態にするかのフラグ
falseにするとS3にのみデータを保存し、検索用DBには保存しないため検索結果には出力されなくなります。S3を用いた分析には利用するが、画面表示時には利用しないなどの場合はfalseにしてください。
time
*required
string		 位置取得日時
位置情報を取得した日時
サーバー時刻+1日よりも未来日の場合はパラメータエラーとなります。
timezoneは日本(JST)。
(yyyy-MM-ddTHH:mm:ss形式)
lat
*required
number		 緯度
世界測地系緯度
DEG形式(10進表記)
最小値 -90
最大値 90
例:35.6894
lon
*required
number		 経度
世界測地系緯度
DEG形式(10進表記)
最小値 -180
最大値 180
例:139.6917
accuracy
number		 水平精度
水平方向の精度(m)
最小値 0
最大値 100,000
bearing
number		 方位
北を0とした時計回り360度
最小値 0
最大値 360
altitude
number		 標高
標高(m)
最小値 -100,000
最大値 100,000
speed
number		 速度
速度(m/s)
最小値 0
最大値 100,000
extra
string		 付加情報
位置情報に付加したい情報を設定してください。
設定した値は取得時に検索条件として指定ができます。検索を考慮した値を設定してください。半角英数字と記号「%」のみ使用可能です。日本語や「%」以外の記号を使用したい場合は、UTF-8のurlエンコードなどを行ってください。
例:テスト → %e3%83%86%e3%82%b9%e3%83%88
最大文字数 200文字
unsearchableExtra
string		 非検索付加情報
位置情報に付加したい情報を設定してください。
設定した値は取得時に検索条件として指定ができません。半角英数字と記号「%」のみ使用可能です。日本語や「%」以外の記号を使用したい場合は、UTF-8のurlエンコードなどを行ってください
例:テスト → %e3%83%86%e3%82%b9%e3%83%88
最大文字数 400文字

Responses

Media type:application/json

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

Example

リクエストURL 
https://[domain]/location/entry-position

・request_data例
{
    "deviceId": "string",
    "positions": [
        {
            "isSearch": true,
            "time": "2019-01-24T00:00:01",
            "lat": 35,
            "lon": 137,
            "accuracy": 10,
            "bearing": 90,
            "altitude": 10,
            "speed": 5,
            "extra": "string",
            "unsearchableExtra": "string"
        },
        {
            "isSearch": true,
            "time": "2019-01-24T00:00:00",
            "lat": 35,
            "lon": 137,
            "accuracy": 10,
            "bearing": 90,
            "altitude": 10,
            "speed": 5,
            "extra": "string",
            "unsearchableExtra": "string"
        }
    ]
}
レスポンス 
{
    "response": {
        "status": {
            "returnCode": 0
        }
    }
}