第15章スイッチデータの取得

API名:
switchData

概要:
車載機からのスイッチデータ(バック・ウィンカ情報)を取得します。

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

メソッド:
GET


API使用例:

Request URL: https://ドメイン名/openapi/v1/vehicle/switchData?vehicleCode="627"&startTime="2021-08-26 09:00:00"&endTime="2021/08/26 11:00:00"

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


各リクエストパラメータは下記の通りです。
パラメータ名
必須
データ型
デフォルト
説明
vehicleCode
Number
車両コードを指定します。※1
startTime
String
作業の開始時刻を指定します。※2、※3
endTime
String
作業の終了時刻を指定います。※2、※3
dbId
Number
運行IDを指定します。

※1


‍‍vehicleCode、startTime、endTimeの3つ、またはdbIdの指定が必須です。
vehicleCode, startTime, endTimeよりもdbIdが優先されます。

※2


指定できるstartTime~endTimeまでの長さは最大24時間です。

※3


ISO8601拡張形式での指定は下記の通りです。
yyyy-mm-ddTh:mm:ssZ        協定世界時UTCとして処理します。
yyyy-mm-ddThh:mm:ss+09:00  日本標準時JSTとして処理します。
yyyy-mm-ddThh:mm:ss        日本標準時JSTとして処理します。
正しいフォーマットで指定されていない場合、エラーとなります。
各レスポンスパラメータは下記の通りです。
パラメータ名
データ型
説明
status
Object
ステータス情報が入ります。
code
String
ステータスコードが入ります。
詳しい内容は状態コードとエラー‌を参照してください。
message
String
ステータス内容に関するメッセージが入ります。
詳しい内容は状態コードとエラー‌を参照してください。
results
Object
リクエスト結果の情報が入ります。
resultsの中身のパラメータは下記の通りです。
パラメータ名
データ型
説明
recordInfoList
Array
スイッチデータ(バック・ウィンカ情報)の情報が入ります。
recordCode
String
レコード区分が入ります。
(詳しくは下記の表を参照してください。)
time
String
レコード時刻が入ります。※1

※1


レスポンスではyyyy/mm/dd hh:mm:ssのフォーマットで取得します。
レコード区分
レコード名
F19E
バックギアON
F19F
バックギアOFF
F1AD
右ウィンカーOFF
F1AE
右ウィンカーON
F1AF
左ウィンカーOFF
F1B0
左ウィンカーON
レスポンス例
  {                    
   "status": {                   
       "code": "AF00E0000",                    ‍‍       
       "message": "SUCCESS"                         
   },                      ‍‍       
   "results":{                    
       "recordInfoList":[                    ‍‍        
          {                    ‍‍      
          "recordCode":"F19E",                  ‍‍        
          "time":"2021/08/26 09:10:00"                 ‍‍       
          },                           
          {                           
          "recordCode":"F19F",                          
          "time":"2021/08/26 09:10:30"                          
          },                           
          {                           
          "recordCode":"F1AE",                          
          "time":"2021/08/26 10:00:00"                          
          },                           
          {                           
          "recordCode":"F1AD",                          
          "time":"2021/08/26 10:11:00"                          
          }                           
       ]                            
   }                             
  }