location/search-position-history

位置履歴検索

端末1台の最大24時間分の位置情報履歴を検索します。
データ保存期間をすぎると自動削除を行うため、さかのぼって検索できる期間はデータ保存期間に依存します。

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

https://[domain]/location/search-position-history

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文字
fromTime
*required
string		 開始日時
取得対象の開始日時
yyyy-MM-ddTHH:mm:ss形式
終了日時が設定されている場合、それより大きい値が設定されているとパラメータエラーとなります。
一度に検索できる最大期間は24時間です。
fromTime:2019-01-01T00:00:00,toTime:2019-01-01T23:59:59は可。
fromTime:2019-01-01T00:00:00,toTime:2019-01-02T00:00:00は不可。
toTime
*required
string		 終了日時
取得対象の終了日時
yyyy-MM-ddTHH:mm:ss形式
開始日時が設定されている場合、それより小さい値が設定されているとパラメータエラーとなります。
一度に検索できる最大期間は24時間です。
fromTime:2019-01-01T00:00:00,toTime:2019-01-01T23:59:59は可。
fromTime:2019-01-01T00:00:00,toTime:2019-01-02T00:00:00は不可。
searchExtraWord
string		 付加情報検索キーワード
検索したいキーワードを設定してください。
半角英数字と記号「%,*」のみ使用可能です。部分一致の場合は*でワイルドカード検索が可能です。部分一致の場合はカンマ「,」区切りで複数単語を設定することによりOR検索が可能です。日本語を使用したい場合は、UTF-8のurlエンコードなどを行ってください。
例:テスト → %e3%83%86%e3%82%b9%e3%83%88
最大文字数 200文字
searchOption
string
default forward		 検索オプション
forward:前方一致 partial:部分一致。
前方一致の方が高速なため前方一致での検索を推奨します。
thinOutType
string		 間引き種別
間引き方法を設定してください。
time:時間で間引き処理を行う。
count:個数で間引き処理を行う。
thinOutNumber
integer		 間引き数
間引く頻度を設定してください。
timeの場合は秒指定
countの場合は個数指定。
最初と最後のデータは間引きされません。
timeを5秒で指定した場合は、5秒毎のデータに間引きします。
00:01:00~00:01:07までの連続した位置情報があった場合は、00:01:00,00:01:05,00:01:07を出力します。
countを10で指定した場合は、存在する位置情報が10個毎のデータに間引きします。
23個の位置情報がある場合は、1番目,11番目,21番目,23番目を出力します。
最小値 0
最大値 86,400
order
string
default asc		 ソート順
日付ソートの順番を設定してください。
asc:昇順
desc:降順
limit
integer
default 100		 取得件数
取得開始位置を基準とした取得件数。
最小値 1
最大値 86,400
offset
integer
default 1		 取得開始位置
絞込み後のデータに対する取得開始位置。
最小値 1
最大値 86,400

Responses

Media type:application/json

キー名 説明
response status returnCode
integer		 処理結果コード
0:正常
0以外:エラーコード
errorMessage
string		 エラーメッセージ
returnCodeが0以外の場合に出力
result limitAfterCount
integer		 limit後件数
limitによる絞り込み後の件数。positionsの個数と同数。
limitBeforeCount
integer		 limit前件数
limitによる絞り込み前の件数。
limitとoffsetを指定しなかった場合に取得できるデータの総件数と同数。
deviceId
string		 端末ID
取得対象の端末ID。
positions time
string		 位置取得日時
位置情報を取得した日時。
timezoneは日本(JST)。
(yyyy-MM-ddTHH:mm:ss形式)
lat
number		 緯度
世界測地系緯度
DEG形式(10進表記)
例:35.6894
lon
number		 経度
世界測地系緯度
DEG形式(10進表記)
例:139.6917
accuracy
number		 水平精度
水平方向の精度(m)。
bearing
number		 方位
北を0とした時計回り360度
altitude
number		 標高
標高(m)。
speed
number		 速度
速度(m/s)。
extra
string		 付加情報
検索条件として利用できる位置情報に付加された情報。
unsearchableExtra
string		 非検索付加情報
検索条件として利用できない位置情報に付加された情報。

Example

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

・request_data例
{
    "deviceId": "string",
    "fromTime": "2019-01-24T00:00:01",
    "toTime": "2019-01-24T00:00:01",
    "searchExtraWord": "hogehoge",
    "searchOption": "forward",
    "thinOutType": "count",
    "thinOutNumber": 10,
    "order": "asc",
    "limit": 100,
    "offset": 1
}
レスポンス 
{
    "response": {
        "status": {
            "returnCode": 0
        },
        "result": {
            "limitAfterCount": 2,
            "limitBeforeCount": 2,
            "deviceId": "string",
            "positions": [
                {
                    "time": "yyyy-MM-ddTHH:mm:ss",
                    "lat": 35,
                    "lon": 137,
                    "accuracy": 10,
                    "bearing": 90,
                    "altitude": 10,
                    "speed": 5,
                    "extra": "string",
                    "unsearchableExtra": "string"
                },
                {
                    "time": "yyyy-MM-ddTHH:mm:ss",
                    "lat": 35,
                    "lon": 137,
                    "accuracy": 10,
                    "bearing": 90,
                    "altitude": 10,
                    "speed": 5,
                    "extra": "string",
                    "unsearchableExtra": "string"
                }
            ]
        }
    }
}