7. 未登録者クラスタリング関連のインターフェース
7.1 未登録者クラスタリング関連の設定変更
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
未登録者クラスタリング関連の設定を変更します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1333”
Yes
interval
int
重複排除期間(単位:分) 重複排除期間のオプションは、0、1、3、5、10、30、60分で、デフォルト値は1分です。
Yes
10
threshold
int
認識の閾値
[65,100]から選択、初期値は80
Yes
70
enable
int
イネーブルスイッチ
1:有効
0:無効
Yes
1
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
json
戻りデータ
msg
string
結果の説明
リクエストの例
レスポンスの例
7.2 未登録者クラスタリングの設定のQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
未登録者クラスタリングの設定をQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1334”
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
enable
int
イネーブルスイッチ 1:有効
0:無効
interval
int
重複排除期間(単位:分) 重複排除期間のオプションは、0、1、3、5、10、30、60分で、デフォルト値は1分です。
threshold
int
認識の閾値
[65,100]から選択、初期値は80
リクエストの例
レスポンスの例
7.3 未登録者アーカイブの詳細のページングQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
未登録者データベースに登録されている未登録者のIDをもとに、ページごとにアーカイブの詳細をQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1065”
Yes
person_id
string
未登録者データベースの未登録者ID
Yes
start_no
int
開始位置
デフォルト値:1
No
1
qry_len
int
Queryのアイテム数 [1,50] デフォルト値:10
No
10
channels
string
チャンネル番号をカンマで区切ったリストで、空の場合はすべてのチャンネルをQueryします。
No
1,3,6
start_time
string
開始時刻
時間の形式:YYYY-MM-DD HH:MM:SS
No
2019-09-02 10:10:10
stop_time
string
終了時刻
時間の形式:YYYY-MM-DD HH:MM:SS
No、start_timeが指定されている場合は、stop_timeも指定する必要があります。
2019-09-02 20:20:20
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
record
json list
戻りデータ
result_num
int
Query結果の数
total_num
int
総レコード数
フィールド情報(レコード)
パラメーター
型
説明
camera_name
string
カメラ名
channel
int
チャンネル
値の範囲:SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
biometric_attr
json
顔属性
付録B参照
img_id
string
未登録者データベースの未登録者ID
lib_id
int
未登録者データベースID
lib_name
string
Null
lib_type
int
Null
alive_type
int
Aliveタイプ
0:不明
1:非Alive
2:Alive
appear_count
int
現在の発生件数
img_path
string
未登録者データベースの画像パス
alarm_type
int
顔認識アラートの種類
0:アラートなし
1:要注意リスト/登録者リストアラート
2:未登録者アラート
3:未登録者DBヒットアラート
event_type
int
イベントアラートの種類
0:アラートなし
1:徘徊アラート
2:ステイイングアラート
stranger_appear_channel
int
未登録者データベース画像のキャプチャーチャンネル
wander_channels
string
徘徊アラート用に設定された徘徊ワンダリングの場所
wander_deviceID
int
徘徊アラートが発生したカメラ名
wander_trigger
int
徘徊アラートのトリガー時間
position
string
カメラ位置
ranking
int
1は比較結果の中で最も高い順位を示します。
similarity
int
ランキングをマッピングした顔画像の一致度係数
値の範囲:[0,100]
snap_id
string
キャプチャーID
snap_path
string
キャプチャーパス
threshold
int
閾値
値の範囲:[0,100]
trigger
string
キャプチャー時間
リクエストの例
レスポンスの例
7.4 ページネーションモードで未登録者アーカイブの詳細をエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ページネーションモードで未登録者アーカイブの詳細をエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“2051”
Yes
person_id
string
未登録者データベースの未登録者ID
Yes
start_no
int
開始位置
デフォルト値:1
No
1
qry_len
int
Queryのアイテム数 [1,50]
デフォルト値:10
No
10
channels
string
チャンネル番号をカンマで区切ったリストで、空の場合はすべてのチャンネルをQueryします。
No
1,3,6
start_time
string
開始時刻の形式:YYYY-MM-DD HH:MM:SS
No
2019-09-02 10:10:10
stop_time
string
終了時刻の形式:YYYY-MM-DD HH:MM:SS
No、start_timeが指定されている場合は、stop_timeも指定する必要があります。
2019-09-02 20:20:20
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
export_url
string
エクスポートされるファイルのパス
result_num
int
Query結果の数
total_num
int
総レコード数
zippasswd
string
圧縮されたパスワード
リクエストの例
レスポンスの例
7.5 選択した未登録者アーカイブの詳細をエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
選択した未登録者アーカイブの詳細をエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“2052”
Yes
person_id
string
未登録者データベースの未登録者ID
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
圧縮されたパスワード
リクエストの例
レスポンスの例
7.6 単一の未登録者データベースの画像をQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
単一の未登録者データベースの画像をQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“2057”
Yes
person_id
string
未登録者データベースの未登録者ID
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
record
json list
戻りデータ
result_num
int
Query結果の数
total_num
int
総レコード数
フィールド情報(レコード)
パラメーター
型
説明
person_id
string
未登録者データベースの未登録者ID
camera_name
string
カメラ名
channel
int
チャンネル
値の範囲:SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
position
string
カメラ位置
trigger
string
キャプチャー時間
count
int
予約フィールド
similarity
int
一致度スコア
値の範囲:[0,100]
threshold
int
閾値
値の範囲:[0,100]
snap_path
string
キャプチャー画像の保存パス
quality
double
顔認識品質スコア 値の範囲:[0,100]
feature
string
画像の特徴
lib_id
int
未登録者データベースID
img_id
string
未登録者データベースの未登録者ID
img_path
string
未登録者データベースの画像パス
biometric_attr
json
顔情報の属性
wander_thresHold
int
発生数の閾値
appear_count
int
現在の発生件数
wander_channels
string
徘徊アラート用に設定された徘徊の場所
リクエストの例
レスポンスの例
7.7 未登録者データベースの画像を基準に基づいてQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
未登録者データベースの画像を基準に基づいてQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“2053”
Yes
appear_time
int
現在の発生件数 予約済み、現在は未使用
No
6
channels
string
チャンネル番号をカンマで区切ったリストで、空の場合はすべてのチャンネルをQueryします。
No
1,2,3
start_no
int
開始位置
デフォルト値:1
No
1
qry_len
int
Queryのアイテム数 [1,50]
デフォルト値:10
No
10
start_time
string
開始時刻
No
2020-12-09 00:00:00
stop_time
string
終了時刻
No、start_timeが指定されている場合は、stop_timeも指定する必要があります
2020-12-09 00:00:00
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
record
json list
戻りデータ
result_num
int
Query結果の数
total_num
int
総レコード数
フィールド情報(レコード)
パラメーター
型
説明
img_id
string
未登録者データベースの未登録者ID
person_id
string
未登録者データベースの未登録者ID
camera_name
string
カメラ名
channel
int
チャンネル
値の範囲:SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
position
string
カメラ位置
trigger
string
キャプチャー時間
count
int
予約フィールド
similarity
int
一致度スコア
値の範囲:[0,100]
threshold
int
閾値
値の範囲:[0,100]
snap_path
string
キャプチャー画像の保存パス
lib_id
int
未登録者データベースID
quality
int
品質スコア
値の範囲:[0,100]
feature
string
画像の特徴
img_path
string
未登録者データベースの画像パス
biometric_attr
json
顔情報の属性
wander_thresHold
int
発生数の閾値
appear_count
int
現在の発生件数
wander_channels
string
徘徊アラート用に設定された徘徊の場所
リクエストの例
レスポンスの例
7.8 ページネーションモードでの未登録者データベースの画像のエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ページネーションモードで未登録者データベースの画像をエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“2049”
Yes
appear_time
int
現在の発生件数 予約済み、現在は未使用
No
6
channels
string
チャンネル番号をカンマで区切ったリストで、空の場合はすべてのチャンネルをQueryします。
No
1,2,3
start_no
int
開始位置
Yes
デフォルト値:1
qry_len
int
エクスポートする項目数
最大値:500
Yes
10
start_time
string
開始時刻
No
2020-12-09 00:00:00
stop_time
string
終了時刻
No、start_timeが指定されている場合は、stop_timeも指定する必要があります。
2020-12-09 00:00:00
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
export_url
string
エクスポートされるファイルのパス
result_num
int
Query結果の数
total_num
int
総レコード数
zippasswd
string
圧縮されたパスワード
リクエストの例
レスポンスの例
7.9 選択した未登録者データベースの画像のエクスポート
インターフェース
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
選択した未登録者データベースの画像をエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
2050
Yes
person_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
圧縮されたパスワード
リクエストの例
レスポンスの例
7.10 ワンダリングアラートのレコードを基準に基づいてQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
徘徊アラートのレコードを、基準に基づいてQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
2054
Yes
channel
int
チャンネル
値の範囲:SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
No
start_time
string
開始時刻
No
stop_time
string
終了時刻
No、start_timeが指定されている場合は、stop_timeも指定する必要があります。
start_no
int
開始位置
No
デフォルト値:1
qry_len
int
Query項目の数
最大値:50
No
デフォルト値:10
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
record
json list
戻りデータ
result_num
int
Query結果の数
total_num
int
総レコード数
フィールド情報(レコード)
パラメーター
型
説明
camera_name
string
カメラ名
channel
int
チャンネル
値の範囲:SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
create_time
string
作成日時
img_id
string
未登録者データベースの未登録者ID
img_path
string
未登録者データベースの画像パス
lib_id
int
未登録者データベースID
lib_name
string
データベース名
lib_type
int
データベースの種類
1:要注意リストデータベース、2:登録者リストデータベース
position
string
カメラ位置
ranking
int
1は比較結果の中で最も高い順位を示します。
similarity
int
一致度スコア
値の範囲:[0,100]
snap_id
string
キャプチャーID
snap_path
string
キャプチャーパス
threshold
int
閾値
値の範囲:[0,100]
trigger
string
キャプチャー時間
alive_type
int
Aliveタイプ
0:不明
1:非Alive
2:Alive
biometric_attr
json
顔キャプチャーの属性
詳細は付録Bを参照
alarm_type
int
顔認識アラートの種類
0:アラートなし
1:要注意リスト/登録者リストアラート
2:未登録者アラート
3:未登録者DBヒットアラート
appear_count
int
現在の発生件数
event_type
int
イベントアラートの種類
0:アラートなし
1:徘徊アラート
2:ステイイングアラート
wander_channels
string
徘徊アラート用に設定された徘徊の場所
wander_deviceID
string
徘徊アラートのトリガー箇所
wander_trigger
string
徘徊アラートのトリガー時間
stranger_appear_channel
int
未登録者データベース画像のキャプチャーチャンネル
デフォルトでは、顔データベースは作成日時順に並べられます。
リクエストの例
レスポンスの例
7.11 ページネーションモードでのワンダリングアラートのエキスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ページネーションモードでワンダリングアラートをエキスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
2055
Yes
start_no
int
開始位置
No
デフォルト値:1
qry_len
int
エクスポートする項目数
最大値:500
No
デフォルト値:10
channel
int
チャンネル
値の範囲:SenseNebula Basicでは[1,12]、SenseNebula Professionalでは[1,24]
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
圧縮されたパスワード
リクエストの例
レスポンスの例
7.12 選択したワンダリングアラートのエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
選択したワンダリングアラートをエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
2056
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
圧縮されたパスワード
リクエストの例
レスポンスの例
7.13 キャプチャレコードに基づいて未登録者データベースの画像をQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
キャプチャレコードに基づいて未登録者データベースの画像をQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1066”
Yes
snap_id
string
キャプチャーID
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
record
json list
戻りデータ
result_num
int
Query結果の数、ここでは1。
total_num
int
総レコード数、ここでは1。
フィールド情報(レコード)
パラメーター
型
説明
camera_name
string
カメラ名
channel
int
チャンネル 値の範囲:SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
alarm_type
int
顔認識アラートの種類
0:アラートなし
1:要注意リスト/登録者リストアラート
2:未登録者アラート
3:未登録者DBヒットアラート
event_type
int
イベントアラートの種類 0:アラートなし
1:ワンダリングアラート
2:ステイイングアラート
img_id
string
未登録者データベースの未登録者ID
biometric_attr
json
生体キャプチャーの属性
詳細は付録Bを参照
lib_id
int
未登録者データベースID
lib_name
string
Null
lib_type
int
Null
position
string
カメラ位置
ranking
int
1は、比較結果の中で最も高い順位を示します。
similarity
int
一致度スコア
値の範囲:[0,100]
snap_id
string
キャプチャーID
snap_path
string
キャプチャー画像の保存パス
threshold
int
閾値
値の範囲:[0,100]
trigger
string
キャプチャー時間
リクエストの例
レスポンスの例
7.14 徘徊アラートの閾値の設定
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
徘徊アラートの閾値を設定します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1335”
Yes
channels
string
徘徊アラート用に設定されたワンダリングの場所。有効なチャンネルのみ設定可能。
Yes
appeared_times
int
徘徊の回数、選択された徘徊箇所での未登録者の出現数の閾値。0よりも大きくする必要があります。
Yes
enable
int
イネーブルスイッチ
1:有効
0:無効
Yes
interval
int
設定された徘徊時間
未登録者の徘徊期間。 オプションは3、5、7、15で、それぞれ「3日」、「5日」、「7日」、「15日」を意味する
デフォルト値は3。
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
string
検証コード文字列
msg
string
結果の説明
リクエストの例
レスポンスの例
7.15 徘徊アラートの閾値のQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
徘徊アラートの閾値をQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1336”
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード(0:成功)
data
string
検証コード文字列
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
enable
int
イネーブルスイッチ
1:有効
0:無効
interval
int
設定された徘徊時間、未登録者の徘徊期間
オプションは3、5、7、15で、それぞれ「3日」、「5日」、「7日」、「15日」を意味する
デフォルト値は3。
channels
string
徘徊アラート用に設定された徘徊の場所
appeared_times
int
徘徊の数、選択された徘徊箇所での未登録者の出現数の閾値。0よりも大きくする必要があります。
リクエストの例
レスポンスの例
Last updated