運転分析結果通知 API

/violation/push [POST]

基本情報

概要

運転分析APIの分析完了後、分析結果(Base64形式へのエンコード)を連携元企業側に通知を行います。

実装企業

API利用企業

URL

https://{HOST}/violation/push

出力形式

• JSON

パラメータ

なし

リクエストボディ

リクエストボディ 注意点

走行データはGZIP圧縮(RFC1952)したJSON文字列をBase64形式エンコードしリクエストボディに設定してください。

リクエストボディ パラメータ

全パラメータ必須項目

パラメータ名		概要	型名	選択値/制限
target		分析対象
	company	企業ID	文字列
	user_id	利用ユーザを識別するID	文字列	半角英数字128文字まで
	analyze_id	分析を識別するID	文字列	半角英数字128文字まで
	datum	走行データ 測地系	文字列	wgs84(世界測地系) tokyo(日本測地系)
	lonlat_format	走行データ フォーマット	文字列	degree(度表記) millsec(ミリ秒)
	car_type	車種	文字列	乗用or貨物 車両サイズ に対応した設定値
result		分析結果
	status	分析結果	文字列	success:受付成功 error:受付失敗 invaild input:入力値不正
	message	分析結果メッセージ	文字列
summary/violation		分析サマリー
	stops_count	一時不停止検出数	数値
	speeds_count	速度超過検出数	数値
	railroad_crossings_count	踏切不停止超過検出数	数値
	passage_prohibited_count	進入禁止検出数	数値
	car_type_passage_prohibited_count	車種別進入禁止検出数	数値
detail/violation		分析詳細
	time	日時	文字列	フォーマット YYYYMMDDhhmmss
	type	違反種別	文字列	stops:一時不停止 speeds:速度超過 railroad_crossings:踏切不停止 passage_prohibited:進入禁止 car_type_passage_prohibited: 車種別進入禁止
	coordinates	位置情報	配列	緯度経度(世界測地系/度表記表示)
	property/speed	上限速度からの超過速度	数値	速度超過以外の場合、0固定
	property/speed_limit	速度上限	数値	速度超過以外の場合、0固定

リクエストボディ サンプル

{
  "target": {
    "company": "company_code",
    "user_id": "user1",
    "analyze_id": "analyze1",
    "datum": "wgs84",
    "lonlat_format": "degree"
  },
  "result": {
    "status": "success",
    "message": null
  },
  "summary": {
    "violation": {
      "stops_count": 1,
      "speeds_count": 0,
      "railroad_crossings_count": 0,
      "passage_prohibited_count": 0,
      "car_type_passage_prohibited_count": 0
    }
  },
  "detail": {
    "violation": [
      {
        "time": "20201122100030",
        "type": "stops",
        "coordinates": [
          [
            139.999943,
            35.363491
          ]
        ],
        "property": {
          "speed": 0,
          "speed_limit": 0
        }
      }
    ]
  }
}

レスポンス

レスポンス パラメータ

パラメータ名	概要	型名	説明
status	分析受付結果	文字列	success:受付成功 error:受付失敗
error	エラーメッセージ	配列	受付時に発生したエラー情報を設定

レスポンス サンプル(StatusCode:200)

{
  "status": "success",
  "error": null
}

レスポンス サンプル(StatusCode:400)

{
  "status": "error",
  "error": [
    "Company is not allowed."
  ]
}