3. 顔関連のインターフェース
3.1 すべての顔データベースのQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
すべての顔データベースをQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1028”
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
create_time
string
作成日時
lib_id
int
データベースID
lib_name
string
データベース名
lib_type
int
データベースの種類 1：要注意リストデータベース
2：登録者リストデータベース
picture_no
int
データベースに登録されている画像数
update_time
string
更新日時
リクエストの例
{
"msg_id":"1028"
}レスポンスの例
{
"code": 0,
"data": [
{
"create_time": "2019-01-23 10:54:13",
"lib_id": 1,
"lib_name": "test01",
"lib_type": 1,
"picture_no": 6,
"update_time": "2019-01-23 10:54:13"
}
],
"msg": ""
}3.2 顔データベースの作成
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
顔データベースを作成します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1025”
Yes
lib_name
string
新しいデータベースの名前
Yes
lib_type
int
データベースの種類 1：要注意リストデータベース
2：登録者リストデータベース
Yes
2
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
lib_id
int
新しいデータベースのID
lib_name
string
新しいデータベースの名前
リクエストの例
{
"msg_id":"1025",
"lib_name":"test",
"lib_type":1
}レスポンスの例
{
"code": 0,
"data": {
"lib_id": 2,
"lib_name": "test"
},
"msg": ""
}3.3 顔データベースの削除
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
顔データベースを削除します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1026”
Yes
lib_id
int
削除するデータベースのID
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
Null
msg
string
結果の説明
リクエストの例
{
"msg_id":"1026",
"lib_id":23
}レスポンスの例
{
"code":0,
"data":"",
"msg":""
}3.4 顔データベースの変更
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
顔データベースを変更します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1027”
Yes
lib_id
int
修正するデータベースのID
Yes
lib_name
string
データベース名
Yes
lib_type
int
データベースの種類 1：要注意リストデータベース
2：登録者リストデータベース
Yes
1
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
lib_id
int
データベースID
lib_name
string
データベース名
リクエストの例
{
"msg_id":"1027",
"lib_id":1,
"lib_name":"test",
"lib_type":1
}レスポンスの例
{
"code": 0,
"data": {
"lib_id": 1,
"lib_name": "test"
},
"msg": ""
}3.5 基準に基づいた対象データベースのQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
基準に基づいて対象データベースをQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1034”
Yes
start_no
int
開始位置
No
デフォルト値：1
qry_len
int
Query項目の数：最大値：50
No
デフォルト値：10
lib_id
int
データベースID
No
lib_name
string
データベース名
No
lib_type
int
データベースの種類 1：要注意リストデータベース 2：登録者リストデータベース
No
1
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
record
json list
返された結果
result_num
int
Query結果の数
total_num
int
総レコード数
フィールド情報(レコード)
パラメーター
型
説明
create_time
string
作成日時
lib_id
int
データベースID
lib_name
string
データベース名
lib_type
int
データベースの種類 1：要注意リストデータベース
2：登録者リストデータベース
picture_no
int
画像数
update_time
string
更新日時
デフォルトでは、顔データベースは作成日時順に並べられます。
リクエストの例
{
"msg_id":"1034",
"start_no":1,
"qry_len":1
}レスポンスの例
{
"code": 0,
"data": {
"record": [
{
"create_time": "2019-01-23 10:54:13",
"lib_id": 1,
"lib_name": "test",
"lib_type": 1,
"picture_no": 6,
"update_time": "2019-01-23 10:54:13"
}
],
"result_num": 1,
"total_num": 1
},
"msg": ""
}3.6 単一の顔画像のQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
単一の顔画像をQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1032”
Yes
img_id
string
Query対象の顔画像のID
Yes
lib_id
int
Query対象のデータベイスのID
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
create_time
string
作成日時
img
string
画像（base64-トランスコード）
img_feat
string
画像の特徴
img_id
string
顔画像のID
img_path
string
画像パス
lib_id
int
顔画像を保存するデータベースのID
person_addr
string
住所
person_age
string
年齢、0～999
person_gender
string
性別
0：女性 1：男性
person_idcard
string
属性コード
person_name
string
氏名
リクエストの例
{
"msg_id":"1032",
"lib_id":8,
"img_id":"test"
}レスポンスの例
{
"code": 0,
"data": {
"create_time": "2019-01-23 11:34:52",
"img": "\ufffd\ufffff\u001c\ufffd\u0014Q_-\ufffd\ufffdfdfd",
"img_feat": "2442,501,111,179,482,239,414,486,49,111,143,169,192,247",
"img_id": "test",
"img_path": "img/1_a2d7ae51-f551-43c0-9bf5-af12ff32c630.png",
"lib_id": 1,
"person_addr": "SH",
"person_age": "14",
"person_gender": "1",
"person_idcard": "123",
"person_name": "renlian1"
},
"msg": ""
}3.7 単一の顔画像をデータベースに保存
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/form
リクエストメソッド
POST
リクエストパラメーター形式
FORM
インターフェースの説明
単一の顔画像をデータベースに保存します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1029”
Yes
lib_id
int
顔画像が保存されるデータベースのID
Yes
img
file
保存する顔画像
Yes
img_id
string
保存する顔画像のID、画像の識別子。カスタマイズが可能で、データベース内で一意である必要があります。英字、数字、ハイフン（-）を含むことができ、長さは最大48文字です。
No
person_idcard
string
属性コード
No
person_name
string
氏名
No
person_gender
string
性別
0：女性
1：男性
No
person_age
string
年齢、0～999
No
person_addr
string
住所
No
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
img_id
string
画像ID
画像ファイルは、jpg/jpeg/png/bmp/tif形式にのみ対応しています。
img_idは、顔画像を一意に識別するものであり、繰り返し使用することはできません。指定しない場合や空欄の場合は、画像IDが自動的に割り当てられます。
リクエストの例
Input Files
{
'img': name='15427121547955542.jpg'
}
"img_id":"test",
"lib_id":11,
"msg_id":"1029"レスポンスの例
{
"code": 0,
"data": {
"img_id": "test"
},
"msg": ""
}3.8 単一の顔画像の削除
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
単一の顔画像を削除します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1031”
Yes
img_id
string
画像ID
Yes
lib_id
int
画像が保存されている顔データベースのID
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
Null
msg
string
結果の説明
リクエストの例
{
"msg_id":"1031",
"img_id":"test_3",
"lib_id":8
}レスポンスの例
{
"code": 0,
"data": "",
"msg": ""
}3.9 単一の顔画像の属性の変更
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
指定した顔データベースの顔画像の属性を変更します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1033”
Yes
img_id
string
画像ID
Yes
lib_id
int
画像が保存されている顔データベースのID
Yes
person_idcard
string
属性コード
No
person_name
string
氏名
No
person_gender
string
性別
0：女性
1：男性
No
person_age
string
年齢、0～999
No
person_addr
string
住所
No
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
img_id
string
画像ID
lib_id
int
画像が保存されている顔データベースのID
リクエストの例
{
"msg_id":"1033",
"img_id":"test",
"lib_id":8,
"person_age":"90"
}レスポンスの例
{
"code": 0,
"data": {
"img_id": "test",
"lib_id": 8
},
"msg": ""
}3.10 基準に基づいた顔画像のQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
指定した顔データベースの画像を基準に基づいて検索します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1035”
Yes
lib_id
int
画像が保存されている顔データベースのID
Yes
start_no
int
開始位置
No
デフォルト値：1
qry_len
int
Query項目の数
最大値：50
No
デフォルト値：10
person_idcard
string
属性コード（完全検索に適用）
No
person_name
string
氏名（完全検索に適用）
No
person_age
string
年齢
0～999 （完全検索に適用）
No
person_gender
string
性別（完全検索に適用）
0：女性
1：男性
No
person_addr
string
住所（完全検索に適用）
No
create_time
string
作成日時
No
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
record
json list
戻りデータ
result_num
int
Query結果の数
total_num
int
総レコード数
フィールド情報(レコード)
パラメーター
型
説明
person_idcard
string
属性コード
person_addr
string
住所
person_age
string
年齢、0～999
person_gender
string
性別
0：女性 1：男性
img_id
string
画像ID
person_name
string
氏名
img_path
string
画像パス
lib_id
int
顔画像を保存するデータベースのID
create_time
string
作成日時
デフォルトでは、顔画像は作成日時順にソートされます。
リクエストの例
{
"msg_id":"1035",
"lib_id":1,
"person_addr":"******"
}レスポンスの例
{
"code": 0,
"data": {
"record": [
{
"create_time": "2019-01-23 12:00:19",
"img_id": "test_4",
"img_path": "img/1_692198ba-e9ea-4ca3-bcf8-2b7a56fd734b.png",
"lib_id": 1,
"person_addr": "******",
"person_age": "14",
"person_gender": "1",
"person_idcard": "******",
"person_name": "wang"
}
],
"result_num": 1,
"total_num": 1
},
"msg": ""
}3.11 ページネーションモードでの顔画像のエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ページネーションモードでの顔画像のエクスポート
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1038”
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
圧縮されたパスワード
エクスポートするコンテンツには、カンマを含めないでください。
リクエストの例
{
"msg_id":"1038",
"lib_id":1
}レスポンスの例
{
"code": 0,
"data": {
"export_url": "tmp/biometric_2019-01-23-12-04-27.zip",
"result_num": 10,
"total_num": 16,
“zippasswd”:”xxxx”"
},
"msg": ""
}3.12 選択した顔画像のエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
指定した顔データベースから選択した顔画像をエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1041”
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
圧縮されたパスワード
エクスポートするコンテンツにカンマを含めないでください。
リクエストの例
{
"msg_id":"1041",
"lib_id":1,
"img_ids":"test,test_4"
}レスポンスの例
{
"code": 0,
"data": {
"export_url": "tmp/biometric_2019-01-23-12-06-19.zip",
"failed_img_ids": "",
"result_num": 2,
"total_num": 2,
“zippasswd”:”xxxx”"
},
"msg": ""
}3.13 基準に基づいてキャプチャレコードをQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
基準に基づいてキャプチャレコードをQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1037”
Yes
channel
int
チャンネル
値の範囲：SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
No
lib_name
string
顔データベースの名称
No
lib_type
int
データベースの種類 1：要注意リストデータベース
2：登録者リストデータベース
No
start_time
string
開始時刻
No
yyyy-MM-dd HH:mm:ss
stop_time
string
終了時刻
No、start_timeが指定されている場合は、stop_timeも指定する必要があります
yyyy-MM-dd HH:mm:ss
start_no
int
開始位置
No
デフォルト値：1
qry_len
int
Query項目の数
最大値：50
No
デフォルト値：10
alive_type
string
コンマで区切ったAliveタイプ
0：不明
1：非Alive
2：Alive
No
デフォルト値：0,1,2
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
record
json
戻りデータ
result_num
int
Query結果の数
total_num
int
総レコード数
フィールド情報(レコード)
パラメーター
型
説明
camera_name
string
カメラ名
channel
int
チャンネル 値の範囲：SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
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
デフォルトでは、キャプチャーはキャプチャー時間でソートされます。
リクエストの例
{
"msg_id":"1037",
"start_no":1,
"qry_len":1
}レスポンスの例
{
"code": 0,
"data": {
"record": [
{
"camera_name": "no1",
"channel": 3,
"biometric_attr": {
"cap_style": "hat_style_type_none",
"gender_code": "female",
"glass_style": "glasses_style_type_none",
"mustache_style": "mustache_style_type_none",
"st_respirator": "st_respirator_mouth",
"respirator_color": "color_type_none",
"st_age": "st_adult",
"st_age_value": "26.000000",
"st_expression": "st_angry"
},
"lib_id": 1,
"lib_name": "test",
"lib_type": 1,
"position": "",
"ranking": 1,
"similarity": 32,
"snap_id": "9448f6e5-0d8b-4fd0-a13f-98b1a05500ec",
"snap_path": "record/9448f6e5-0d8b-4fd0-a13f-98b1a05500ec.jpg",
"threshold": 100,
"alive_type": 2,
"trigger": "2019-01-23 12:07:53"
}
],
"result_num": 1,
"total_num": 105
},
"msg": ""
}3.14 ページネーションモードでのキャプチャーのエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
基準に基づいてキャプチャをエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1040”
Yes
start_no
int
開始インデックス
No
デフォルト値：1
qry_len
int
エクスポートする項目数
最大値：500
No
デフォルト値：10
channel
int
チャンネル
値の範囲：SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
No
lib_name
string
顔データベースの名称
No
lib_type
int
データベースの種類 1：要注意リストデータベース
2：登録者リストデータベース
No
1
start_time
string
開始時刻
No
stop_time
string
終了時刻
No、start_timeが指定されている場合は、stop_timeも指定する必要があります
alive_type
string
コンマで区切ったAliveタイプ
0：不明
1：非Alive
2：Alive
No
デフォルト値：0,1,2
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
export_url
string
エクスポートされるファイルのパス
result_num
int
Query結果の数
total_num
int
総レコード数
zippasswd
string
圧縮されたパスワード
リクエストの例
{
"msg_id":"1040"
}レスポンスの例
{
"code": 0,
"data": {
"export_url": "tmp/catch_2019-01-23-12-09-42.zip",
"result_num": 10,
"total_num": 108,
“zippasswd”:”xxxx”"
},
"msg": ""
}3.15 選択した生体キャプチャのエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
選択したキャプチャーをエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1043”
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
圧縮されたパスワード
リクエストの例
{
"msg_id":"1043",
"snap_ids":"74a199aa-dad7-4d3a-95f0-f74dbb818974,f12ed623-87d6-49e0-939a-97262a0407e9"
}レスポンスの例
{
"code": 0,
"data": {
"export_url": "tmp/catch_2019-01-23-12-44-37.zip",
"failed_img_ids": "",
"result_num": 5,
"total_num": 5,
“zippasswd”:”xxxx”"
},
"msg": ""
}3.16 基準に基づいてアラートレコードをQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
基準に基づいてアラートレコードをQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1036”
Yes
channel
int
チャンネル
値の範囲：SenseNebula Basicでは[1,12]、SenseNebula Professionalでは[1,24]
No
lib_name
string
顔データベースの名称
No
lib_ids
string
IDのセット
No
lib_type
int
データベースの種類 1：要注意リストデータベース
2：登録者リストデータベース
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
alive_type
string
コンマで区切ったAliveタイプ
0：不明
1：非Alive
2：Alive
非Alive画像は比較対象にならない
No
デフォルト値：0,2
レスポンスパラメーター
パラメーター
型
説明
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,12]、SenseNebula Professionalでは[1,24]
create_time
string
作成日時
img_id
string
画像ID
img_path
string
画像パス
lib_id
int
データベースID
lib_name
string
データベース名
lib_type
int
データベースの種類
1：要注意リストデータベース
2：登録者リストデータベース
person_addr
string
住所
person_age
string
年齢、0～999
person_gender
string
性別
0：女性
1：男性
person_idcard
string
属性コード
person_name
string
氏名
position
string
カメラ位置
ranking
int
1は、比較結果の中で最も高い順位を示します。
similarity
int
一致度スコア
値の範囲：[0,100］
snap_id
string
生体キャプチャーID
snap_path
string
生体キャプチャーパス
URLを連結
threshold
int
比較の閾値（カメラバウンド） 値の範囲：[0,100］
trigger
string
トリガー時間
alive_type
int
Aliveタイプ
0：不明
1：非Alive 2：Alive
デフォルトでは、キャプチャーはキャプチャー時間でソートされます。
リクエストの例
{
"msg_id":"1036",
"start_no":1,
"qry_len":1
}レスポンスの例
{
"code": 0,
"data": {
"record": [
{
"camera_name": "no2",
"channel": 2,
"biometric_attr": {
"cap_style": "hat_style_type_none",
"gender_code": "female",
"glass_style": "glasses_style_type_none",
"mustache_style": "mustache_style_type_none",
"st_respirator": "st_respirator_mouth",
"respirator_color": "color_type_none",
"st_age": "st_adult",
"st_age_value": "26.000000",
"st_expression": "st_angry"
},
"create_time": "2019-01-23 11:37:26",
"img_id": "71f11a77-94c0-43c9-ab23-6e9076f6127a",
"img_path": "img/1_71f11a77-94c0-43c9-ab23-6e9076f6127a.jpg",
"lib_id": 1,
"lib_name": "test",
"lib_type": 1,
"person_addr": "******",
"person_age": "14",
"person_gender": "",
"person_idcard": "******",
"person_name": "1101060000000061481",
"position": "aaa",
"ranking": 1,
"similarity": 35,
"snap_id": "1d9abf3d-09e1-4ef2-8832-f3d025ae0f91",
"snap_path": "record/1d9abf3d-09e1-4ef2-8832-f3d025ae0f91.jpg",
"threshold": 10,
"trigger": "2019-01-23 14:29:22",
"alive_type": 2
}
],
"result_num": 1,
"total_num": 297
},
"msg": ""
}3.17 ページネーションモードでのアラート画像のエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ページネーションモードでのアラート画像をエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1039”
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
alive_type
string
コンマで区切ったAliveタイプ
0：不明 1：非Alive
2：Alive
非Alive画像は比較対象にならない
No
デフォルト値：0,2
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
export_url
string
エクスポートされるファイルのパス
result_num
int
Query結果の数
total_num
int
総レコード数
zippasswd
string
圧縮されたパスワード
リクエストの例
{
"msg_id": "1039",
"lib_ids": "1"
}レスポンスの例
{
"code": 0,
"data": {
"export_url": "tmp/alarm_2019-01-23-14-31-51.zip",
"result_num": 10,
"total_num": 298,
“zippasswd”:”xxxx”"
},
"msg": ""
}3.18 選択されたアラート画像のエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
選択されたアラート画像をエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1042”
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
圧縮されたパスワード
リクエストの例
{
"msg_id":"1042",
"snap_ids":"91f3705f-539b-4474-8f8b-fffb86d8ffa7"
}レスポンスの例
{
"code": 0,
"data": {
"export_url": "tmp/alarm_2019-01-23-14-35-29.zip",
"failed_img_ids": "",
"result_num": 1,
"total_num": 1,
“zippasswd”:”xxxx”"
},
"msg": ""
}3.19 キャプチャ画像またはアラート画像のオプションの削除
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
キャプチャ画像またはアラート画像のオプションを削除します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“2129”
Yes
catch_ids
string
Queryで得られる画像IDのセット（画像IDはカンマ[,]で区切ります。画像数は1～50）
Yes
type
int
削除タイプ 0：顔画像 1：全身画像
2：アラート画像
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
Null
msg
string
結果の説明
リクエストの例
{
"msg_id": "2129",
"catch_ids": "11,22,33,44",
"type": 0
}レスポンスの例
{
"code": 0,
"data": "",
"msg": ""
}3.20 顔画像をデータベースに一括保存
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/form
リクエストメソッド
POST
リクエストパラメーター形式
FORM
インターフェースの説明
顔画像を一括してデータベースに保存します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1030”
Yes
lib_id
int
データベースID
Yes
img_*
file list
顔画像
Yes
uuid
string
バッチ識別子
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
失敗した場合のレスポンス
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
url
string
データベースの保存情報を含むCSVファイル
err_count
int
データベースに保存できない画像数
一括して取り込む画像ファイルの名前は、Name_img_id_Identity_Gender_Age_Addressの形式でなければなりません。
img_idは、画像を識別するための属性です。カスタマイズが可能で、データベース内で一意でなければなりません。英字、数字、ハイフン（-）を含むことができ、長さは最大48文字です。
性別は、0または1に設定できます。0は女性、1は男性を表します。
各画像ファイル名には、指定された順序で属性を与え、アンダースコア(_)で属性を区切ります。システムは画像の属性を自動的に取得します。属性がない場合は、ナンバー記号（#）で埋めてください。
リクエストの例
Input Files
{
'img_1': name='zhangsan_asdqwe12345_32011111_0_23_beijing.jpg',
'img_2': name='lisi_abcdse0987_32011111_1_41_shanghai.jpg’,
...
}
"msg_id":"1030",
"lib_id":11,
"uuid":"test"レスポンスの例
{
"code": 0,
"data": {
"err_count": 0,
"url": "tmp/image_.csv"
},
"msg": ""
}3.21 顔画像を一括で削除
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
顔画像を一括で削除します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1044”
Yes
img_ids
string
画像ID、複数の画像IDをカンマ（,）で区切ります（最大50IDまで）
Yes
lib_id
int
画像が保存されている顔データベースのID
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
Null
msg
string
結果の説明
リクエストの例
{
"msg_id":"1044",
"img_ids":"f30c0f4b-d783-44a5-b118-b4db9ea2b8c4,85b728f8-ed96-42c3-a7e2-f811cf7a1481",
"lib_id":2
}レスポンスの例
{
"code": 0,
"data": "",
"msg": ""
}3.22 キャプチャーレコードとアラートレコードの削除
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
キャプチャーレコードとアラートレコードを削除します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1045”
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
Null
msg
string
結果の説明
リクエストの例
{
"msg_id":"1045"
}レスポンスの例
{
"code": 0,
"data": "",
"msg": ""
}3.23 基準に基づいて全身キャプチャのレコードをQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
基準に基づいて全身キャプチャのレコードをQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1046”
Yes
channel
int
チャンネル
値の範囲：SenseNebula Basicでは[1,12]、SenseNebula Professionalでは[1,24]
No
start_time
string
開始時刻
No
yyyy-MM-dd HH:mm:ss
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,12]、SenseNebula Professionalでは[1,24]
position
string
カメラ位置
quality
int
顔認識品質スコア
値の範囲：[0,100]
snap_id
string
キャプチャーのID
snap_path
string
キャプチャーのパス
trigger
string
キャプチャー時間
デフォルトでは、キャプチャーはキャプチャー時間でソートされます。
リクエストの例
{
"msg_id":"1046",
"start_no":1,
"qry_len":1,
"channel":1,
"start_time":"2019-10-16 13:20:00",
"stop_time":"2019-10-16 18:00:00"
}レスポンスの例
{
"code": 0,
"data": {
"record": [
{
"body_attr": {
"bag_style": "bag_style_type_none",
"cap_style": "hat_style_type_none",
"coat_color": "black",
"coat_length": "long_sleeve",
"coat_style": "t_shirt",
"gender_code": "female",
"hair_color": "black",
"hair_style": "long",
"shoes_color": "black",
"shoes_style": "sandal",
"st_age": "st_adult",
"st_bag": "st_bag",
"st_coat_pattern": "st_pure",
"st_hat": "st_hat",
"st_pedestrian_angle": "st_front",
"st_respirator": "st_respirator",
"st_trousers_pattern": "st_pure",
"st_umbrella": "st_umbrella",
"trousers_color": "black",
"pants_length_type": "st_skirt",
"glasses_style_type": "glasses_style_type_none",
"st_glove": "st_glove",
"st_status_stype": "st_normal",
"st_uniform": "st_common_clothing",
"trousers_len": "st_skirt"
},
"camera_name": "c1",
"channel": 1,
"position": "",
"quality": 67,
"snap_id": "cb19f0a6-0e55-4b86-8079-d22d530ad14e",
"snap_path": "record/17/body/cb19f0a6-0e55-4b86-8079-d22d530ad14e.jpg",
"trigger": "2019-10-16 14:01:41"
}
],
"result_num": 1,
"total_num": 371
},
"msg": ""
}3.24 ページネーションモードでの全身画像のエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ページネーションモードでの全身画像をエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1048”
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
終了時刻
start_timeが指定されている場合、stop_timeも指定する必要があります。
No
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
export_url
string
エクスポートされるファイルのパス
result_num
int
Query結果の数
total_num
int
総レコード数
zippasswd
string
圧縮されたパスワード
リクエストの例
{
"msg_id":"1048"
}レスポンスの例
{
"code": 0,
"data": {
"export_url": "tmp/body_2019-10-23-12-09-42.zip",
"result_num": 10,
"total_num": 108,
“zippasswd”:”xxxx”"
},
"msg": ""
}3.25 選択した全身キャプチャーのエクスポート
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
選択した全身キャプチャーをエクスポートします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1047”
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
圧縮されたパスワード
リクエストの例
{
"msg_id":"1047",
"snap_ids":"74a199aa-dad7-4d3a-95f0-f74dbb818974,f12ed623-87d6-49e0-939a-97262a0407e9"
}レスポンスの例
{
"code": 0,
"data": {
"export_url": "tmp/body_2019-01-23-12-44-37.zip",
"failed_img_ids": "",
"result_num": 2,
"total_num": 2,
“zippasswd”:”xxxx”"
},
"msg": ""
}3.26 単一の顔情報（Base64エンコード）のデータベースへの保存
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
指定したバイオメトリクスデータベースに単一の顔画像を追加します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1051”
Yes
lib_id
int
顔画像が保存されるデータベースのID
Yes
img
json
保存される顔画像
Yes
img_id
string
保存する顔画像のID、画像の識別子。カスタマイズが可能で、データベース内で一意である必要があります。英字、数字、ハイフン（-）を含むことができ、長さは最大48文字。
No
person_idcard
string
属性コード
No
person_name
string
氏名
No
person_gender
string
性別（0：女性、1：男性）
No
person_age
string
年齢、0～999
No
person_addr
string
住所
No
フィールド情報(img)
パラメーター
型
説明
filename
string
ファイル名
data
string
base64エンコーディングデータ
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
img_id
string
画像ID
画像ファイルは、jpg/jpeg/png/bmp/tif形式にのみ対応しています。
img_idは顔画像を一意に識別するもので、繰り返して使用することはできません。指定されていない場合や空欄の場合は、自動的に画像IDが割り当てられます。
リクエストの例
Input Files
{
"msg_id":"1051",
"lib_id":1,
"img": {
"filename":"haha.jpg",
"data":"data:image/jpg;base64,/9jxxxxx4EpB/9k="
}
}レスポンスの例
{
"code": 0,
"data": {
"img_id": "test"
},
"msg": ""
}3.27 顔画像（Base64エンコード）のデータベースへの一括保存
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
顔情報を一括してデータベースに保存します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1052”
Yes
lib_id
int
データベースID
Yes
imgs
json
顔画像、画像リスト
Yes
uuid
string
バッチ識別子
Yes
フィールド情報(img)
パラメーター
型
説明
filename
string
ファイル名
data
string
base64エンコーディングデータ
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
失敗した場合のレスポンス
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
url
string
データベースの保存情報を含むCSVファイル
err_count
int
データベースに保存できない画像数
一括してインポートする画像ファイルの名前は、Name_img_id_Identity_Gender_Age_Addressの形式でなければなりません。。
img_idは、画像を識別するための属性です。カスタマイズが可能で、データベース内で一意でなければなりません。英字、数字、ハイフン（-）を含むことができ、長さは最大48文字です。
性別は0、または1に設定できます。0は女性、1は男性を表します。
各画像ファイル名には、指定された順序で属性を与え、アンダースコア(_)で属性を区切ります。システムは画像の属性を自動的に取得します。属性が空の場合は、ナンバー記号（#）で埋めてください。
リクエストの例
Input Files
{
"msg_id":"1052",
"lib_id":1,
"uuid":"xxyyzz",
"imgs": [
{
"filename":"haha.jpg",
"data":"data:image/jpg;base64,/9jxxxxx4EpB/9k="
}
]
}レスポンスの例
{
"code": 0,
"data": {
"err_count": 0,
"url": "tmp/image_.csv"
},
"msg": ""
}3.28 現在の結果のQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
現在の結果をQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1050”
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
戻りデータ
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
key_person_cnt
int
キーパーソンカウント
white_list_cnt
int
登録者リストカウント
stranger_cnt
int
未登録者カウント
リクエストの例
{
"msg_id":"1050"
}レスポンスの例
{
"code": 0,
"data": {
"key_person_cnt": 1145,
"white_list_cnt": 88,
"stranger_cnt": 44
},
"msg": ""
}Last updated