メインコンテンツへスキップ

YAML→HTML変換テスト

MSPF-NEXT-DEV Admin
更新

データアップロード

データアップロード
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 2.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

GetUploadCondition

UploadData

GetUploadCondition

Up 
post /stbdc/probe/2/get-upload-condition
アップロード条件取得API (stbdcProbe2GetUploadConditionPost)
リクエストした車両または端末のアップロード条件ファイルを応答する

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/xml

Request body

body 2_getuploadcondition_body (optional)
Body Parameter — 補足）XML形式のBodyデータをcontent-encoding(gzip)へ圧縮したデータを設定する

Request headers

content-type (required)
Header Parameter — text/xml を指定する
content-encoding (required)
Header Parameter — gzip を指定する
accept-encoding (required)
Header Parameter — gzip を指定する
x-api-key (required)
Header Parameter — APIGatewayの認証キーを指定する
token (required)
Header Parameter — 認証基盤から取得したトークン値(access_token)を指定。<br>「'Bearer '＋access_token」の形式にて設定する
x-session-id (optional)
Header Parameter — リクエストを一意に管理するためのセッションIDを指定する
x-authorization-code (required)
Header Parameter — 認証基盤を指定する
clientid (required)
Header Parameter — 認証基盤で使用するクライアントIDを指定する
user_id (optional)
Header Parameter — ユーザー識別子を指定する
PersonalID (optional)
Header Parameter — スマホTBDCへリクエストするPersonalID<br>※最小1文字、最大255文字で「英数字（大文字小文字判定有）、一部記号（ハイフンマイナス、アンダーバー）<br>（RFC 3986の非予約文字からピリオドとチルダを除外したもの）」を指定する
device-id (required)
Header Parameter — 端末識別子
partner-code (required)
Header Parameter — 事業者コード
vehicle-id (optional)
Header Parameter — 車両識別ID

Return type

inline_response_200

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/xml

Responses

200 ResponsesのBody情報（正常）
inline_response_200
400 ResponsesのBody情報: リクエストデータ異常（リクエストヘッダーの不正）
inline_response_400
403 リクエストデータ異常（認証不正）
404 データなし
500 サーバ内エラー
504 処理タイムアウト　ボディ無し
4XX 予期しないエラーが発生。サーバ要因エラーのため ご連絡ください
5XX 予期しないエラーが発生。サーバ要因エラーのため ご連絡ください

UploadData

Up 
post /stbdc/probe/2/upload-data
データアップロードAPI (stbdcProbe2UploadDataPost)
アップロード条件ファイルに従ったデータをアップロードするために使用する

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/xml

Request body

body 2_uploaddata_body (optional)
Body Parameter — 補足）XML形式のBodyデータをcontent-encoding(gzip)へ圧縮したデータを設定する

Request headers

content-type (required)
Header Parameter — text/xml を指定する
content-encoding (required)
Header Parameter — gzip を指定する
accept-encoding (required)
Header Parameter — gzip を指定する
x-api-key (required)
Header Parameter — APIGatewayの認証キーを指定する
token (required)
Header Parameter — 認証基盤から取得したトークン値(access_token)を指定。<br>「'Bearer '＋access_token」の形式にて設定する
x-session-id (optional)
Header Parameter — リクエストを一意に管理するためのセッションIDを指定する
x-authorization-code (required)
Header Parameter — 認証基盤を指定する
clientid (required)
Header Parameter — 認証基盤で使用するクライアントIDを指定する
user_id (optional)
Header Parameter — ユーザー識別子を指定する
PersonalID (optional)
Header Parameter — スマホTBDCへリクエストするPersonalID<br>※最小1文字、最大255文字で「英数字（大文字小文字判定有）、一部記号（ハイフンマイナス、アンダーバー）<br>（RFC 3986の非予約文字からピリオドとチルダを除外したもの）」を指定する
data-send-date (required)
Header Parameter — データ送信日時
partner-code (required)
Header Parameter — 事業者コード
location-accuracy (required)
Header Parameter — 位置情報精度
device-id (required)
Header Parameter — 端末識別子
vehicle-id (optional)
Header Parameter — 車両識別ID

Return type

inline_response_200_1

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/xml

Responses

200 ResponsesのBody情報（正常）
inline_response_200_1
400 ResponsesのBody情報: リクエストデータ異常（リクエストヘッダーの不正）
inline_response_400_1
403 リクエストデータ異常（認証不正）
404 データなし
500 サーバ内エラー
504 処理タイムアウト　ボディ無し
4XX 予期しないエラーが発生。サーバ要因エラーのため ご連絡ください
5XX 予期しないエラーが発生。サーバ要因エラーのため ご連絡ください

Models

[ Jump to Methods ]

Table of Contents

  1. 2_getuploadcondition_body
  2. 2_uploaddata_body
  3. DirectionsAPIRequest-get-upload-condition - get-upload-condition Request body
  4. DirectionsAPIRequest-upload-data - upload-data Request body
  5. DirectionsAPIRequestgetuploadcondition_Request
  6. DirectionsAPIRequestuploaddata_Request
  7. DirectionsAPIRequestuploaddata_Request_CollectDataList
  8. DirectionsAPIRequestuploaddata_Request_CollectDataList_CAN
  9. DirectionsAPIRequestuploaddata_Request_CollectDataList_CollectData
  10. DirectionsAPIRequestuploaddata_Request_CollectDataList_GPS
  11. DirectionsAPIRequestuploaddata_Request_CollectDataList_MM
  12. DirectionsAPIRequestuploaddata_Request_CollectDataList_MM_ADAS
  13. DirectionsResponse-get-upload-condition - get-upload-condition Response body(Statucode:200:ok)
  14. DirectionsResponse-upload-data - upload-data Response body(Statucode:200:ok)
  15. DirectionsResponse400-get-upload-condition - get-upload-condition Response body(Statucode:400)
  16. DirectionsResponse400-upload-data - -upload-data Response body(Statucode:400)
  17. DirectionsResponse400getuploadcondition_Result
  18. DirectionsResponse400uploaddata_Result
  19. DirectionsResponsegetuploadcondition_Result
  20. DirectionsResponsegetuploadcondition_Result_CANCollectionConditionList
  21. DirectionsResponsegetuploadcondition_Result_CANCollectionConditionList_CANCollectionCondition
  22. DirectionsResponseuploaddata_Result
  23. inline_response_200
  24. inline_response_200_1
  25. inline_response_400
  26. inline_response_400_1

2_getuploadcondition_body Up

2_uploaddata_body Up

DirectionsAPIRequest-get-upload-condition - get-upload-condition Request body Up

Request
DirectionsAPIRequestgetuploadcondition_Request

DirectionsAPIRequest-upload-data - upload-data Request body Up

Request
DirectionsAPIRequestuploaddata_Request

DirectionsAPIRequestgetuploadcondition_Request Up

処理要求
UploadConditionID
String アップロード条件ID
example: 1
Destination
String 仕向け情報
example: 0
DCUMEUType
String DCU/MEU分類
example: IF-BOX
MapVersion
String 地図データバージョン
MessageVersion
String 電文バージョン
example: 2
DCUAppVersion
String DCUアプリ対応管理No
MEUAppVersion
String MEUアプリ対応管理No
SDKVersion
String SDKバージョン
AppVersion
String アプリバージョン
example: 1.0
ElectronicPF
String 電子PF情報

DirectionsAPIRequestuploaddata_Request Up

処理要求
UploadConditionID
String アップロード条件ID
example: 1
Destination
String 仕向け情報
example: 0
DCUMEUType
String DCU/MEU分類
example: IF-BOX
MapVersion
String 地図データバージョン
MessageVersion
String 電文バージョン
example: 2
DCUAppVersion
String DCUアプリ対応管理No
MEUAppVersion
String MEUアプリ対応管理No
SDKVersion
String SDKバージョン
AppVersion
String アプリバージョン
example: 1.0
ElectronicPF
String 電子PF情報
TimezoneOffset
BigDecimal タイムゾーンオフセット
example: 9
CollectDataList
DirectionsAPIRequestuploaddata_Request_CollectDataList

DirectionsAPIRequestuploaddata_Request_CollectDataList Up

収容データリスト
CollectData
array[DirectionsAPIRequestuploaddata_Request_CollectDataList_CollectData]

DirectionsAPIRequestuploaddata_Request_CollectDataList_CAN Up

CAN情報
RawData
String CANバイナリ情報
example: Base64化したCAN情報

DirectionsAPIRequestuploaddata_Request_CollectDataList_CollectData Up

DateTime
String 日時
GPS
DirectionsAPIRequestuploaddata_Request_CollectDataList_GPS
MM
DirectionsAPIRequestuploaddata_Request_CollectDataList_MM
CAN
DirectionsAPIRequestuploaddata_Request_CollectDataList_CAN

DirectionsAPIRequestuploaddata_Request_CollectDataList_GPS Up

GPS
Latitude
BigDecimal 緯度
Longitude
BigDecimal 経度
PDOP
BigDecimal PDOP
HDOP
BigDecimal HDOP
VDOP
BigDecimal VDOP
SatelliteNumber
BigDecimal 測位衛星数

DirectionsAPIRequestuploaddata_Request_CollectDataList_MM Up

MM
Latitude
BigDecimal 緯度
Longitude
BigDecimal 経度
AreaCode
String 地域コード
LinkID
String Link ID（ナビ表示）
LinkDiffID
String Link IDからの差分ID
Speed
BigDecimal 車速
LineNo
String 走行車線番号
LineTypeRight
String 右白線種別情報
LineTypeLeft
String 左白線種別情報
EntryPoint
BigDecimal リンク進入点（始点）からの距離
MatchingConfidence
BigDecimal マッチング自信度
ADAS
DirectionsAPIRequestuploaddata_Request_CollectDataList_MM_ADAS

DirectionsAPIRequestuploaddata_Request_CollectDataList_MM_ADAS Up

高度運転支援
Mileage
BigDecimal 走行距離(1G ON後)
CurrentPositionCurvature
BigDecimal 現在地曲率
BoundaryCrossingState
String 境界線跨ぎ状態
BoundaryCrossingDirection
String 境界線跨ぎ方向
LineRelativePositionLeft
String 左右白線相対位置情報(左)
LineRelativePositionRight
String 左右白線相対位置情報(右)

DirectionsResponse-get-upload-condition - get-upload-condition Response body(Statucode:200:ok) Up

Result
DirectionsResponsegetuploadcondition_Result

DirectionsResponse-upload-data - upload-data Response body(Statucode:200:ok) Up

Result
DirectionsResponseuploaddata_Result

DirectionsResponse400-get-upload-condition - get-upload-condition Response body(Statucode:400) Up

Result
DirectionsResponse400getuploadcondition_Result

DirectionsResponse400-upload-data - -upload-data Response body(Statucode:400) Up

Result
DirectionsResponse400uploaddata_Result

DirectionsResponse400getuploadcondition_Result Up

処理結果
ResultStatus
String 登録結果
example: 1

DirectionsResponse400uploaddata_Result Up

処理結果
ResultStatus
String 登録結果
example: 1
Description
String 詳細
example: input error

DirectionsResponsegetuploadcondition_Result Up

処理結果
ResultStatus
String 登録結果
example: 0
Description
String 詳細
UploadConditionID
String アップロード条件ID
example: 1
UploadInterval
BigDecimal アップロード周期
example: 60
LocationCollectionInterval
BigDecimal 位置情報収集周期
example: 60
CANCollectionConditionList
DirectionsResponsegetuploadcondition_Result_CANCollectionConditionList

DirectionsResponsegetuploadcondition_Result_CANCollectionConditionList Up

収集CAN情報
CANCollectionCondition
array[DirectionsResponsegetuploadcondition_Result_CANCollectionConditionList_CANCollectionCondition]

DirectionsResponsegetuploadcondition_Result_CANCollectionConditionList_CANCollectionCondition Up

CANID
String CAN ID
example: 0x90
DLC
BigDecimal DLC
example: 8
SamplingType
BigDecimal サンプリング種別
example: 1
Interval
BigDecimal 取集周期
example: 100
MaskData
String マスクデータ
example: FFFF

DirectionsResponseuploaddata_Result Up

処理結果
ResultStatus
String 登録結果
example: 0
Description
String 詳細

inline_response_200 Up

inline_response_200_1 Up

inline_response_400 Up

inline_response_400_1 Up

コメント

0件のコメント

サインインしてコメントを残してください。

Powered by Zendesk