第13章センサーデータの取得

API名：
sensorData

概要：
車載機からのセンサーデータを取得します。

URI：
https://ドメイン名/openapi/v1/vehicle/sensorData

メソッド：
GET

13.1GETメソッド

13.1.1リクエスト

API使用例：

Request URL: https://ドメイン名/openapi/v1/vehicle/sensorData?vehicleCode=627&startTime=2021-08-24%2010:00:00&endTime=2021-08-24%2012:00:00

Request Method: GET
Request Head:
　　　　Authorization: Bearer eyJ4NXQiOiJORE15WXpZMk5X…

各リクエストパラメータは下記の通りです。
パラメータ名
必須
データ型
デフォルト
説明
format
String
json
出力データ形式を指定してください。（json/csv）
指定をしない場合は、json形式になります。※1
vehicleCode
Number
車両コードを指定します。(数字8桁以内)
startTime
String
作業の開始時刻を指定します。
フォーマットは、ISO8601拡張形式で指定します。※1、※2、※3
endTime
String
作業の終了時刻を指定します。
フォーマットは、ISO8601拡張形式で指定します。※1、※2、※3
dbId
Number
運行IDを指定します。
運行IDを指定する場合（format=json）は、vehicleCode、startTime、endTimeは必要ありません。
format=csvの場合は指定できません。
limit
Number
7200（1時間分）
1度のリクエストで取得するレコード件数を指定します。（7200〜172800）※4
offset
Number
0
レコードの取得開始位置を指定します。※5

※1


dbIdを指定している場合、vehicleCode、startTime、endTimeでの指定は反映されません。

format=csvの場合は、dbIdを指定できません。
vehicleCode、startTime、endTimeの3つすべてを指定する必要があります。
その場合は、limit、offsetでの指定は反映されません。

startTime〜endTimeまでの長さは暫定的に最大24時間とします。

※2


ISO8601拡張形式として以下のフォーマットで指定します。

・yyyy-mm-ddThh:mm:ssZ協定世界時UTC


・yyyy-mm-ddThh:mm:ss+09:00日本標準時JST


・yyyy-mm-ddThh:mm:ss日本標準時JST

※3


startTime <= センサデータの記録時刻 < endTime を満たすセンサデータを返却します。（endTimeと同じ時刻のデータは含まれません）

※4


limitの下限は7,200件、上限は172,800件です。

※5


offset≧0の値を指定してください。

13.1.2レスポンス


【　出力形式をjson型に指定した場合　】
各レスポンスパラメータは下記の通りです。
パラメータ名
データ型
説明
status
Object
ステータスに関する情報を持っているオブジェクトです。
code
String
ステータスコードが入ります。
詳しい内容は状態コードとエラーを参照してください。
message
String
ステータス内容に関するメッセージが入ります。
詳しい内容は下記の状態コードとエラーを参照してください。
results
Object
リクエスト結果の情報が入ります。
totalCount
Number
リクエストに一致する合計レコード数が入ります。
count
Number
今回の応答で取得されたレコード数が入ります。
offset
Number
リクエストで指定されたレコードの取得開始位置（offsetの値をそのまま埋めて返す）が入ります。
sensorDataList
Array
センサーデータの情報が入ります。
センサーデータの詳しい内容は下記sensorDataListを参照ください。

sensorDataListの配列の中身のパラメータは下記の通りです。
パラメータ名
データ型
説明
time
String
日時の情報が入ります。
speed
Number
速度の情報が入ります。
単位:km/h（小数第1位まで）
範囲:0～180.0
latitude
String
緯度の情報が入ります。
longitude
String
経度の情報が入ります。
engine
Number
エンジン回転数の情報が入ります。
単位:rpm
範囲:0～6000
positioning
Number
測位情報の情報が入ります。
0:未測位
1:2次元測位
2:3次元測位
dop　
Number
Dop値の情報が入ります。
（GPSモジュールからの値で測位精度を表し、値が大きい程精度が悪い、無効値：null）※2
範囲:0～99　
gyro　
Number
ジャイロの情報が入ります。
対応センサと向きについては、付録を参照してください。　※1、※2
無効値：null　例：0.5）
単位:deg/s（小数第1位まで）
範囲:-250.0～250.0 
installationPosition
Number
車載機取付位置（無効値：null 例：2）
1〜6
g1　
Number
G1：横方向の情報が入ります。
対応センサと向きについては、付録を参照してください。※1、※2
(無効値：null　例：0.11）
単位:G（小数第2位まで）
範囲:-2.00～2.00 
g2　
Number
G2：前後方向の情報が入ります。
対応センサと向きについては、付録を参照してください。　※1、※2
無効値：null　例：0.21）
単位:G（小数第2位まで）
範囲:-2.00～2.00 
g3　
Number
G3：上下方向の情報が入ります。
対応センサと向きについては、付録を参照してください。※1、※2
無効値：null　例：0.31）
単位:G（小数第2位まで）
範囲:-2.00～2.00 　
loadKind
Number
実車/空車区分の情報が入ります。
1:空車
2:実車
3:回送　
roadKind
Number
道路区分の情報が入ります。
1:一般道
2:市街地
3:高速道
4:専用道
distance　
Number
車間距離の情報が入ります。（無効値：null）※2
単位:m（小数第2位まで）
範囲:0～327.66

※1


ジャイロ、Gセンサの方向は車載機を平置き表示部正面取り付けの場合
  各取付方向によるジャイロ、Gセンサの方向は、下記のリンク先を参照ください。

　センサーデータの詳細               

※2


無効値について、車載機の実際値を出力しなくて、nullを出力します。
車載機の実際値は以下のとおりです。
dop: 99
gyro: -32767
g1/g2/g3: -511
distance: 32767 

※dbIdを指定した上で、センサーデータがない場合エラーとなります。




※車両と期間を指定した上で、センサーデータがない場合エラーとなります。

【　出力形式をCSV型に指定した場合　】
各レスポンスパラメータは下記の通りです。
パラメータ名
データ型
説明
status
Object
ステータス情報が入ります。
code
String
ステータスコードのが入ります。
詳しい内容は状態コードとエラーを参照してください。
message
String
ステータス内容に関するメッセージが入ります。
詳しい内容は状態コードとエラーを参照してください。
results
Object
リクエスト結果の情報が入ります。
fileUrl
String
センサーデータを取得するURLです。
センサーデータの中身は、sensorDataListがCSV形式で出力されます。

※センサーデータがない場合、URLを返さず、エラーとなります。
出力形式がJSONの場合のレスポンス例
 {               
  "status": {              
     "code": "AF00E0000",             
     "message": "SUCCESS"             
  },              
  "results"：{              
     "totalCount": 10000,             
     "count": 2000,             
     "offset":5000,              
     "sensorDataList": [             
         {            
         "time":"2021/10/14 05:00:00.000",           
         "speed":60.0,           
         "latitude":"035.40.403",           
         "longitude":"139.46.131",           
         "engine":2000,           
         "positioning":1,           
         "dop":10,           
         "gyro":0.1,           
         "g1":0.11,           
         "g2":0.22,           
         "g3":0.33,           
         "loadKind":1,           
         "roadKind":2,           
         "distance":10.00,
"installationPosition":2         
         },      
         {            
         "time":"2021/10/14 05:00:00.500",           
         "speed":60.0,           
         "latitude":"035.40.403",           
         "longitude":"139.46.131",           
         "engine":2000,           
         "positioning":1,           
         "dop":10,           
         "gyro":0.1,           
         "g1":0.11,           
         "g2":0.22,           
         "g3":0.33,           
         "loadKind":1,           
         "roadKind":2,           
         "distance":10.00,
         "installationPosition":2      
         },            
     ]             
  }              
 }               
出力形式がCSV形式の場合のレスポンス例
 ‍{                                                      
   status: {                                                     
    code: "AF00E0000",                                                    
    message: "SUCCESS"                                                    
   },                                                     
   "results"：{                                                     
    "fileUrl": "https://itpv3.transtron.fujitsu.com/csvdownload/00000333_00000001_TTI-newstep3_
　　センサーデータ_1630133552299_4507.zip?filename=センサーデータ.zip"‍
   }                                                     
 ‍}                                                      
                                                        
 ‍センサーデータがない場合：                                                      
 ‍{                                                      
   status: {                                                     
    code: "AF00E0013",                                                    
    message: "指定した期間にセンサーデータがありません。" ‍
   },                                                     
   "results"：{}                                                     
 ‍}