4. 車両関連インターフェース

4.1 車両データベースの作成

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両データベースを作成します。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

1053

Yes

lib_name

string

データベース名

Yes

testlibname

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0はOK)

data

json

結果データ

msg

string

記載された結果

フィールド情報(データ)

パラメーター

説明

lib_id

int

戻り値

lib_name

string

戻り値

リクエストの例

レスポンスの例

4.2 車両データベースの削除

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両データベースを削除します。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

1054

Yes

lib_id

int

データベースID

Yes

5

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0はOK)

data

json

結果データ

msg

string

記載された結果

フィールド情報(データ)

パラメーター

説明

lib_id

int

戻り値

lib_name

string

戻り値

リクエストの例

レスポンスの例

4.3 車両データベースの修正

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両データベースを修正します。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1055”

Yes

lib_id

int

データベースID

Yes

5

lib_name

int

データベース名

Yes

modifyname

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0はOK)

data

json

結果データ

msg

string

記載された結果

リクエストの例

レスポンスの例

4.4 全車両データベースのQuery

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

全車両データベースをQueryします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1056”

Yes

レスポンスパラメーター

パラメーター

説明

code

int

エラーコード(0:成功)

data

json

結果データ

msg

string

エラーの説明

フィールド情報(データ)

パラメーター

説明

create_time

string

作成日時

lib_id

int

データベースID

lib_name

string

データベース名

update_time

string

更新日時

リクエストの例

レスポンスの例

4.5 車両データベースのページングQuery

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両データベースのページングQuery

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1057”

Yes

start_no

int

開始位置

No

デフォルト値 1

qry_len

int

Query数 最大:50

No

デフォルト値 10

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0はOK)

data

json

結果データ

msg

string

記載された結果

フィールド情報(データ)

パラメーター

説明

record

json list

戻り値

result_num

int

Query結果の数

total_num

int

総数

フィールド情報(レコード)

パラメーター

説明

create_time

string

作成日時

vehicle_num

int

Queryにおける車両数

lib_id

int

データベースID

lib_name

string

データベース名

update_time

string

更新日時

リクエストの例

レスポンスの例

4.6 車両データベースへのナンバープレート情報の追加

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/form

リクエストメソッド

POST

リクエストパラメーター形式

FORM

インターフェースの説明

車両データベースへのナンバープレート情報を追加します。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1058”

Yes

vehicle_number

string

ライセンス番号 長さ:[1,48]

Yes

Y NLV880

img

file

ナンバープレートの画像

No

test.jpg

lib_id

string

データベースID

Yes

1

vehicle_color

string

カラー

[0, 32]

No

red

vehicle_type

string

タイプ

[0, 32]

No

big_hus

vehicle_brand

string

ブランド

[0, 32]

No

Benz

owner_idcard

string

オーナーIDカード

[0, 128]

No

xxx

owner_name

string

オーナー名

[0, 128]

No

xxx

owner_gender

string

オーナーの性別

[0, 4]

No

1:男性

0:女性

owner_age

string

オーナーの年齢

[0, 4]

No

50

is_vip

string

VIPかどうか?

No

1:VIP

0:VIPではない

レスポンスパラメーター

パラメーター

説明

code

int

エラーコード(0:成功)

data

json

結果データ

msg

string

エラーの説明

フィールド情報(データ)

パラメーター

説明

img_id

string

車両のuuid

リクエストの例

レスポンスの例

4.7 車両データベースの車両を削除

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両データベースの車両を削除します。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1060”

Yes

vehicle_number

string

ライセンス番号の設定

','で分割

ライセンス番号の数は1から50まで

Yes

YNLV420

lib_id

int

車両データベースID

Yes

1

レスポンスパラメーター

パラメーター

説明

code

int

エラーコード(0:成功)

data

json

Null

msg

string

エラーの説明

リクエストの例

レスポンスの例

4.8 車両データベースに登録されているナンバープレート情報のQuery

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両データベースに登録されているナンバープレート情報をQueryします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1063”

Yes

start_no

int

開始インデックス

No

デフォルト値:0

qry_len

int

ページサイズ

No

デフォルト値:10

lib_id

int

データベースID

No

vehicle_number

string

車両番号

No

owner_name

string

オーナー名

No

fuzzy_key

string

ファジーマッチキー

No

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

record

json list

戻りデータ

result_num

int

Query結果の数

total_num

int

総レコード数

フィールド情報(レコード)

パラメーター

説明

img_id

string

車両ID

vehicle_number

string

車両番号

img_path

string

車両画像のパス

lib_id

int

データベースID

vehicle_type

string

車両タイプ

vehicle_color

string

車両カラー

vehicle_brand

string

車両ブランド

owner_id_card

string

オーナーID

owner_name

string

オーナー名

owner_gender

string

オーナーの性別

owner_age

string

オーナーの年齢

create_time

string

作成日時

is_vip

int

VIPか?

0:No

1:Yes

作成日時順に並んでいます。

リクエストの例

レスポンスの例

4.9 車両キャプチャーレコードのQuery

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両キャプチャーレコードをQueryします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1793”

Yes

start_no

int

開始インデックス

No

デフォルト値:1

qry_len

int

ページサイズ

No

デフォルト値:10

channel

int

チャンネル

No

start_time

string

開始時刻

No

yyyy-MM-dd HH:mm:ss

stop_time

string

終了時刻

No、start_timeが指定されている場合は、stop_timeも指定する必要があります

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

record

json list

戻りデータ

result_num

int

Query結果の数

total_num

int

総レコード数

フィールド情報(レコード)

パラメーター

説明

snap_id

string

キャプチャID

camera_name

string

カメラID

channel

int

チャンネルID

trigger_time

int

トリガー時間

position

string

位置

snap_path

string

キャプチャ画像のパス

quality

string

品質

vehicle_number

string

車両番号

vehicle_attr

json

車両の属性、付録Dを参照

create_time

string

作成日時

作成日時順に並んでいます。

リクエストの例

レスポンスの例

4.10 車両アラートレコードのQuery

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両アラートレコードをQueryします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1794”

Yes

start_no

int

開始インデックス

No

デフォルト値:1

qry_len

int

ページサイズ

No

デフォルト値:10

channel

int

チャンネル

No

start_time

string

開始時刻

No

yyyy-MM-dd HH:mm:ss

stop_time

string

終了時刻

No、start_timeが指定されている場合は、stop_timeも指定する必要があります

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

record

json list

戻りデータ

result_num

int

Query結果の数

total_num

int

総レコード数

フィールド情報(レコード)

パラメーター

説明

snap_id

string

キャプチャID

camera_name

string

カメラID

channel

int

チャンネルID

trigger_time

int

トリガー時間

position

string

位置

snap_path

string

キャプチャ画像のパス

quality

string

品質

create_time

string

作成日時

img_id

string

車両ID

vehicle_number

string

車両番号

vehicle_attr

json

車両の属性、付録Dを参照

img_path

string

車両画像のパス

lib_name

string

車両データベース名

owner_id_card

string

オーナーID

owner_name

string

オーナー名

owner_gender

string

オーナーの性別

owner_age

string

オーナーの年齢

is_vip

int

VIPか?

0:No

1:Yes

作成日時順に並んでいます。

リクエストの例

レスポンスの例

4.11 選択した車両画像のエクスポート

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

選択した車両画像をエクスポートします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1795”

Yes

lib_id

int

データベースID

Yes

img_ids

string

Queryで得られる車両IDのセット(車両IDはカンマ[,]で区切る。数量は1~50)。

Yes

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

export_url

string

エクスポートされるファイルのパス

failed_img_ids

string

エクスポートできない画像のID

result_num

int

Query結果の数

total_num

int

総レコード数

zippasswd

string

圧縮されたパスワード

リクエストの例

レスポンスの例

4.12 ページネーションモードでの車両画像のエクスポート

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

ページネーションモードでの車両画像をエクスポートします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1796”

Yes

lib_id

int

データベースID

Yes

start_no

int

開始インデックス

No

デフォルト値:1

qry_len

int

エクスポートする項目数

最大値:500

No

デフォルト値:10

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

export_url

string

エクスポートされるファイルのパス

result_num

int

Query結果の数

total_num

int

総レコード数

zippasswd

string

圧縮されたパスワード

リクエストの例

レスポンスの例

4.13 選択した車両キャプチャーのエクスポート

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

選択した車両キャプチャーをエクスポートします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1797”

Yes

snap_ids

string

Queryで得られる画像IDのセット(画像IDはカンマ[,]で区切ります。画像数は1~50)

Yes

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

export_url

string

エクスポートされるファイルのパス

failed_img_ids

string

エクスポートできない画像のID

result_num

int

Query結果の数

total_num

int

総レコード数

zippasswd

string

圧縮されたパスワード

リクエストの例

レスポンスの例

4.14 ページネーションモードでの車両キャプチャのエクスポート

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

基準に基づいて車両キャプチャーをエクスポートします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1798”

Yes

start_no

int

開始インデックス

No

デフォルト値:1

qry_len

int

エクスポートする項目数

最大値:500

No

デフォルト値:10

channel

int

チャンネル

値の範囲:SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]

No

start_time

string

開始時刻

No

stop_time

string

終了時刻

No、start_timeが指定されている場合は、stop_timeも指定する必要があります

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

export_url

string

エクスポートされるファイルのパス

result_num

int

Query結果の数

total_num

int

総レコード数

zippasswd

string

圧縮されたパスワード

リクエストの例

レスポンスの例

4.15 選択した車両アラート画像のエクスポート

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

選択した車両アラート画像をエクスポートします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1799”

Yes

snap_ids

string

Queryで得られる画像IDのセット(画像IDはカンマ[,]で区切ります。画像数は1~50)

Yes

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

export_url

string

エクスポートされるファイルのパス

failed_img_ids

string

エクスポートできない画像のID

result_num

int

Query結果の数

total_num

int

総レコード数

zippasswd

string

圧縮されたパスワード

リクエストの例

レスポンスの例

4.16 ページネーションモードでの車両アラート画像のエクスポート

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

ページネーションモードで車両アラート画像をエクスポートします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1800”

Yes

start_no

int

開始インデックス

No

デフォルト値:1

qry_len

int

エクスポートする項目数

最大値:500

No

デフォルト値:10

channel

int

チャンネル

値の範囲:SenseNebula Basicでは[1,12]、SenseNebula Professionalでは[1,24]

No

lib_name

string

顔データベースの名称

No

lib_type

int

データベースの種類

1:要注意リストデータベース

2:登録者リストデータベース

No

start_time

string

開始時刻

No

stop_time

string

終了時刻

No、start_timeが指定されている場合は、stop_timeも指定する必要があります

lib_ids

string

IDのセット

Yes

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

export_url

string

エクスポートされるファイルのパス

result_num

int

Query結果の数

total_num

int

総レコード数

zippasswd

string

圧縮されたパスワード

リクエストの例

レスポンスの例

4.17 単一の車両画像のQuery

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

単一の車両画像をQueryします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1801”

Yes

img_id

string

Query対象となる車両画像のID

Yes

lib_id

int

Query対象となるデータベースのID

Yes

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

img_id

string

車両画像ID

vehicle_number

string

車両番号

img_path

string

画像保存パス

lib_id

int

車両画像を保存するデータベースのID

vehicle_type

string

車両タイプ

vehicle_color

string

車両カラー

vehicle_brand

string

車両ブランド

owner_idcard

string

オーナーID

owner_name

string

オーナー名

owner_gender

string

オーナーの性別

owner_age

string

オーナーの年齢

create_time

string

作成日時

is_vip

int

VIP

リクエストの例

レスポンスの例

4.18 車両画像の一括削除

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両画像を一括で削除します。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1802”

Yes

img_ids

string

画像ID、複数の画像IDをカンマ(,)で区切ります(最大50IDまで)

Yes

lib_id

int

画像が保存されている顔データベースのID

Yes

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

Null

msg

string

結果の説明

リクエストの例

レスポンスの例

4.19 単一の車両画像の属性変更

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

指定された顔データベースの車両画像の属性を変更します。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1803”

Yes

img_id

string

画像ID

Yes

lib_id

int

画像が保存されている顔データベースのID

Yes

vehicle_number

string

車両番号

No

vehicle_color

string

車両カラー

No

vehicle_type

string

車両タイプ

No

vehicle_brand

string

車両ブランド

No

owner_idcard

string

オーナーID

No

owner_name

string

オーナーの氏名

No

owner_gender

string

オーナーの性別

No

owner_age

string

オーナーの年齢

No

is_vip

int

VIP

No

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

img_id

string

画像ID

vehicle_number

string

車両番号

lib_id

int

画像が保存されている顔データベースのID

リクエストの例

レスポンスの例

4.20 サイクリストのキャプチャーレコードのQuery

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

サイクリストのキャプチャーレコードをQueryします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1804”

Yes

start_no

int

開始インデックス

No

デフォルト値:1

qry_len

int

エクスポートする項目数

最大値:500

No

デフォルト値:10

channel

int

チャンネル

値の範囲:SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]

No

start_time

string

開始時刻

No

stop_time

string

終了時刻

No、start_timeが指定されている場合は、stop_timeも指定する必要があります

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

record

json list

戻りデータ

result_num

int

Query結果の数

total_num

int

総レコード数

フィールド情報(レコード)

パラメーター

説明

snap_id

string

キャプチャID

camera_name

string

カメラ名

channel

int

チャンネル番号

trigger_time

int

トリガー時間

position

string

位置

snap_path

string

キャプチャ画像のパス

quality

string

品質

vehicle_attr

json

車両の属性、付録Dを参照

create_time

string

作成日時

作成日時順に並んでいます。

リクエストの例

レスポンスの例

4.21 選択したサイクリストのキャプチャーのエキスポート

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

選択したサイクリストのキャプチャーをエキスポートします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1805”

Yes

snap_ids

string

Queryで得られる画像IDのセット(画像IDはカンマ[,]で区切ります。画像数は1~50)

Yes

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

export_url

string

エクスポートされるファイルのパス

failed_img_ids

string

エクスポートできない画像のID

result_num

int

Query結果の数

total_num

int

総レコード数

zippasswd

string

圧縮されたパスワード

リクエストの例

レスポンスの例

4.22 ページネーションモードでのサイクリストのキャプチャのエクスポート

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

基準に基づいてサイクリストのキャプチャをエクスポートします。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“1806”

Yes

start_no

int

開始インデックス

No

デフォルト値:1

qry_len

int

エクスポートする項目数

最大値:500

No

デフォルト値:10

channel

int

チャンネル

値の範囲:SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]

No

start_time

string

開始時刻

No

stop_time

string

終了時刻

No、start_timeが指定されている場合は、stop_timeも指定する必要があります。

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

説明

export_url

string

エクスポートされるファイルのパス

result_num

int

Query結果の数

total_num

int

総レコード数

zippasswd

string

圧縮されたパスワード

リクエストの例

レスポンスの例

4.23 車両キャプチャまたはアラート画像のオプションの削除

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

車両キャプチャまたはアラート画像のオプションを削除します。

リクエストパラメーター

パラメーター

説明

必須

msg_id

string

“2130”

Yes

catch_ids

string

Queryで得られる画像IDのセット(画像IDはカンマ[,]で区切ります。画像数は1~50)

Yes

type

int

削除タイプ

0:車両画像

1:サイクリスト画像 2:アラート画像

Yes

レスポンスパラメーター

パラメーター

説明

code

int

結果コード(0:成功)

data

json

Null

msg

string

結果の説明

リクエストの例

レスポンスの例

Last updated