分析結果(違反詳細)に対してのお問い合わせ投稿 API
/violation/opinion [POST]
基本情報
概要
分析結果(違反詳細)に対してのお問い合わせ投稿を行います。
投稿いただいた内容はサービス品質改善に利用します。
実装企業
ナビタイムジャパン
URL
https://{HOST}/violation/opinion
出力形式
- JSON
パラメータ
なし
リクエストボディ
リクエストボディ 注意点
ご意見はGZIP圧縮(RFC1952)したJSON文字列をBase64形式エンコードしリクエストボディに設定してください。
パラメータ名 | 必須 | 概要 | 型名 | 選択値/制限 | デフォルト値 |
---|---|---|---|---|---|
opinion_id | ✔ | ご意見ID | 文字列 | 利用者側でご意見単位で一意になるようなIDを指定 半角英数字128文字まで |
|
company | ✔ | 企業ID | 文字列 | ||
user_id | ✔ | 利用ユーザを識別するID | 文字列 | 半角英数字128文字まで | |
analyze_id | ✔ | 分析を識別するID | 文字列 | 半角英数字128文字まで | |
violation_type | ✔ | 違反種別 | 文字列 | stops:一時不停止 speeds:速度超過 railroad_crossings:踏切不停止 passage_prohibited:進入禁止 car_type_passage_prohibited:車種別進入禁止 |
|
violation_time | ✔ | 違反発生時刻 | 文字列 | フォーマット YYYYMMDDhhmmss |
|
opinion_type | ✔ | 報告種別 | 文字列 | no_regulation:この箇所に規制がない no_violation:この箇所で違反していない no_running:走行していない箇所だった other:その他 |
|
content | ✔ | ご意見投稿内容 | 文字列 | 半角英数字150文字まで |
リクエストボディ サンプル
{
"company": "company_code",
"user_id": "user1",
"analyze_id": "analyze1",
"opinion_id": "opinion1",
"violation_type": "stops",
"violation_time": "20200612194448",
"opinion_type": "no_regulation",
"content": "一時不停止の違反が検知されたが、実際には一時停止の規制は存在しなかった。"
}
レスポンス
レスポンス パラメータ
パラメータ名 | 概要 | 型名 | 説明 |
---|---|---|---|
status | 分析受付結果 | 文字列 | success:受付成功 error:受付失敗 |
error | エラーメッセージ | 配列 | 受付時に発生したエラー情報を設定 |
レスポンス サンプル(StatusCode:200)
{
"status": "success",
"error": null
}
レスポンス サンプル(StatusCode:400)
{
"status": "error",
"error": [
"Company is not allowed.",
"Body is not Base64/Json."
]
}