2.7 レコードの API
2.7.1 認証レコードの表示 (/api/v6/record/list)
概要
認証レコードを表示します。指定期間内のレコードを最大100万件取得できます。
リクエストアドレスの例
https://link.japancv.co.jp/api/v6/record/list
リクエスト方法
GET
リクエストパラメーター
パラメーター名 | 型 | 必須 | 説明 |
order | int | No | 並び順 0 : 認証時間で降順 1 : 認証時間で昇順 |
page | int | No | ページ番号(デフォルトは1) |
size | int | No | 1ページあたりのデータの数(デフォルトは 20)。最大値は100 |
date_time_from | string | No | 顔認証時刻で範囲指定するオプション。(from) デフォルト値は実行時の日付の 0:00:00 例 : 2018-07-20 12:30:45 |
date_time_to | string | No | 顔認証時刻で範囲指定するオプション。(to) デフォルト値は実行時の日付の 23:59:59 例 : 2019-07-20 12:30:45 |
create_at_from | string | No | 認証レコードの作成時刻で範囲指定するオプション。(from) 例 : 2018-07-20 12:30:45 |
create_at_to | string | No | 認証レコードの作成時刻で範囲指定するオプション。(to) 例 : 2019-07-20 12:30:45 |
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
レスポンスのフィールド
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
data | object | データ |
dataフィールドの説明
パラメーター名 | 型 | 説明 |
list | list<recordItem> | 認証レコード詳細 |
page_num | int | ページ番号(デフォルトは1 ) |
page_size | int | 1ページあたりのデータの数(デフォルトは20)。最大値は100 |
recordItem フィールドの説明
パラメーター名 | 型 | 説明 |
id | int | 認証レコードID |
direction | int | デバイスのアクセス方向 |
latitude | double | 緯度 |
longitude | double | 経度 |
address | string | 住所 |
location | string | 勤務地 |
mobile | string | 携帯電話番号 |
remark | string | 特記事項 |
groups | list<group> | グループ |
capture_picture | string | 認証時にデバイスが撮影した写真(サムネイル)のID |
capture_bg_picture | string | 認証時にデバイスが撮影した写真(大)のID |
avatar | string | 認証用顔写真 |
heat_avatar | string | 認証時にデバイスが撮影したサーマル画像 |
user_id | int | 登録者ID |
user_name | string | 登録者名 |
user_type | int | 登録者タイプ |
group_id | int | グループID |
group_name | string | グループ名 |
device_name | string | デバイス名 |
device_ldid | string | デバイスLDID |
sign_time | string | 認証時間 |
country_code | (非サポートのパラメータ) | |
place_code | (非サポートのパラメータ) | |
on_business | (非サポートのパラメータ) | |
entry_mode | int | 認証モード |
sign_time_zone | string | タイムゾーン |
verify_score | float | 認証スコア |
mis_id | int | 誤認証 ID |
mis_type | int | 誤認証タイプ |
doc_photo | string | IDカード写真(利用できません) |
ic_number | string | ICカード番号 |
id_number | string | IDカード番号読み込み(利用できません) |
abnormal_type | int | 異常レコードタイプ 0:なし 10001:IDカード不一致 10002:認証カード不一致 10003:認証コード不一致 20001:ビジターが有効期限外 20002:アクセス時間外 30001:無効なIDカード 30002:無効なICカード 30003:無効なQRコード 40001:体温が異常 50001:マスク着用無し |
job_number | string | 従業員ID |
user_ic_number | string | 登録者ICカード番号 |
user_id_number | string | 登録者ID番号 |
reception_user_id | long | 受付担当者ID |
reception_user_name | string | 受付担当者名 |
user_remark | string | 登録者コメント |
sign_date | string | 認証日 |
body_temperature | float | 体温 |
mask | int | マスク着用識別子 0:不明 1:着用なし 2:着用あり |
create_at | tring | 認証レコード生成時刻 |
id_info | NebulaAttributeVO | SenseNebulaからの属性情報、または SensePass/SenseThunderからの属性情報 |
ext_info | List<Map<String, Object>> | 拡張情報 |
group フィールドの説明
パラメーター名 | 型 | 説明 |
id | long | グループID |
name | string | グループ名 |
type | int | グループタイプ |
id_info フィールドの説明
パラメータ名 | 型 | 説明 |
---|---|---|
cap_style | string | 帽子の情報 hat_style_type_none:帽子着用なし cap: 帽子着用あり |
gender_code | string | 性別 female:女性 male:男性 |
glass_style | string | メガネ情報 glasses_style_type_none:メガネ着用なし transparent_glasses:透明メガネ sunglasses: サングラス st_ordinary_glasses:一般メガネ |
mustache_style | string | ひげ mustache_style_type_none:ヒゲなし whiskers:ひげ |
st_age | string | 年齢層 st_old:シニア層 st_adult: 大人 st_child:子供 |
st_age_value | string | 年齢 |
st_expression | string | 表情 st_angry:怒っている st_happy:機嫌が良い st_sorrow:悲しい st_calm:落ち着いている st_surprised:驚いた st_scared:怖がる st_disgust:嫌がる st_yawn:あくび |
st_respirator | string | マスク着用情報 st_respirator_full:正しい着用状態 st_respirator_nose:正しくない着用状態 st_respirator_mouth:非着用id_info フィールドの説明 |
ext_infoフィールドの説明
ext_infoには、以下のThunderデバイス用アプリケーションが出力する情報が格納されます。
Thunder Attendance
パラメータ名 | 説明 |
---|---|
name | Thunder Attendance では、"attendance_flag" |
value | Thunder Attendanceが出力する勤怠フラグ番号(数字)。値に対応するジェスチャーやフラグはThunder Attendanceのマニュアル 参照 |
エラーレスポンスのフィールド
code | message | desc | 説明 |
30001 | Param Invalid | records pull max-size once:100 | 1回の最大抽出レコード数100を超えています |
30001 | Param Invalid | page-can-not-be-zero | pageを0にできません |
30001 | Param Invalid | size-not-be-zero | sizeを0にできません |
30001 | Param Invalid | date_time_from_out_of_retention_periods_of_records | 認証時間の期間がプランの保存期限を超えています |
30001 | Param Invalid | DATETIME_TO_CANNOT_EARLIER_THAN_DATETIME_FROM | 認証時間の終了日が認証時間の開始日より前に設定されています |
30001 | Param Invalid | DATETIME_FROM_PATTERN_INVALID | 認証時間の開始日のフォーマットが不正です |
30001 | Param Invalid | DATETIME_TO_PATTERN_INVALID | 認証時間の終了日のフォーマットが不正です |
30001 | Param Invalid | Param-invalid. | パラメーターが不正です |
500 | Internal Server Error | internal-server-error | 内部サーバーエラー |
2.7.2 認証レコードの表示 (/api/v5/record/list)
概要
認証レコードを表示します。指定期間内のレコードを最大100万件取得できます。
リクエストアドレスの例
https://link.japancv.co.jp/api/v5/record/list
リクエスト方法
GET
リクエストパラメーター
パラメーター名 | 型 | 必須 | 説明 |
order | int | No | 並び順 0 : 認証時間で降順 1 : 認証時間で昇順 |
page | int | No | ページ番号(デフォルトは1) |
size | int | No | 1ページあたりのデータの数(デフォルトは 20)。最大値は100 |
date_time_from | string | No | 顔認証時刻で範囲指定するオプション。(from) デフォルト値は実行時の日付の 0:00:00 例 : 2018-07-20 12:30:45 |
date_time_to | string | No | 顔認証時刻で範囲指定するオプション。(to) デフォルト値は実行時の日付の 23:59:59 例 : 2019-07-20 12:30:45 |
create_at_from | string | No | 認証レコードの作成時刻で範囲指定するオプション。(from) 例 : 2018-07-20 12:30:45 |
create_at_to | string | No | 認証レコードの作成時刻で範囲指定するオプション。(to) 例 : 2019-07-20 12:30:45 |
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
レスポンスのフィールド
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
data | object | データ |
dataフィールドの説明
パラメーター名 | 型 | 説明 |
list | list<recordItem> | 認証レコード詳細 |
page_num | int | ページ番号(デフォルトは1 ) |
page_size | int | 1ページあたりのデータの数(デフォルトは20)。最大値は100 |
recordItem フィールドの説明
パラメーター名 | 型 | 説明 |
id | int | 認証レコードID |
direction | int | デバイスのアクセス方向 |
latitude | double | 緯度 |
longitude | double | 経度 |
address | string | 住所 |
location | string | 勤務地 |
mobile | string | 携帯電話番号 |
remark | string | 特記事項 |
groups | list<group> | グループ |
capture_picture | string | 認証時にデバイスが撮影した写真(サムネイル)のID |
capture_bg_picture | string | 認証時にデバイスが撮影した写真(大)のID |
avatar | string | 認証用顔写真 |
heat_avatar | string | 認証時にデバイスが撮影したサーマル画像 |
user_id | int | 登録者ID |
user_name | string | 登録者名 |
user_type | int | 登録者タイプ |
group_id | int | グループID |
group_name | string | グループ名 |
device_name | string | デバイス名 |
device_ldid | string | デバイスLDID |
sign_time | string | 認証時間 |
country_code | (非サポートのパラメータ) | |
place_code | (非サポートのパラメータ) | |
on_business | (非サポートのパラメータ) | |
entry_mode | int | 認証モード |
sign_time_zone | string | タイムゾーン |
verify_score | float | 認証スコア |
mis_id | int | 誤認証ID |
mis_type | int | 誤認証タイプ |
doc_photo | string | IDカード写真(利用できません) |
ic_number | string | ICカード番号 |
id_number | string | IDカード番号読み込み(利用できません) |
abnormal_type | int | 異常レコードタイプ 0:なし 10001:IDカード不一致 10002:認証カード不一致 10003:認証コード不一致 20001:ビジターが有効期限外 20002:アクセス時間外 30001:無効なIDカード 30002:無効なICカード 30003:無効なQRコード 40001:体温が異常 50001:マスク着用無し |
job_number | string | 従業員ID |
user_ic_number | string | 登録者ICカード番号 |
user_id_number | string | 登録者ID番号 |
reception_user_id | long | 受付担当者ID |
reception_user_name | string | 受付担当者名 |
user_remark | string | 登録者コメント |
sign_date | string | 認証日 |
body_temperature | float | 体温 |
mask | int | マスク着用識別子 0:不明 1:着用なし 2:着用あり |
create_at | tring | 認証レコード生成時刻 |
id_info | NebulaAttributeVO | SenseNebulaからの属性情報、または SensePass/SenseThunderからの属性情報 |
group フィールドの説明
パラメーター名 | 型 | 説明 |
id | long | グループID |
name | string | グループ名 |
type | int | グループタイプ |
id_info フィールドの説明
パラメータ名 | 型 | 説明 |
---|---|---|
cap_style | string | 帽子の情報 hat_style_type_none:帽子着用なし cap:帽子着用あり |
gender_code | string | 性別 female:女性 male:男性 |
glass_style | string | メガネ情報 glasses_style_type_none:メガネ着用なし transparent_glasses:透明メガネ sunglasses: サングラス st_ordinary_glasses:一般メガネ |
mustache_style | string | ひげ mustache_style_type_none:ヒゲなし whiskers: ひげ |
st_age | string | 年齢層 st_old:シニア層 st_adult:大人 st_child:子供 |
st_age_value | string | 年齢 |
st_expression | string | 表情 st_angry:怒っている st_happy:機嫌が良い st_sorrow:悲しい st_calm:落ち着いている st_surprised:驚いた st_scared:怖がる st_disgust:嫌がる st_yawn:あくび |
st_respirator | string | マスク着用情報 st_respirator_full:正しい着用状態 st_respirator_nose:正しくない着用状態 st_respirator_mouth:非着用 |
エラーレスポンスのフィールド
コード | メッセージ | 説明 |
30001 | Param Invalid | 1回の最大抽出レコード数100を超えています |
30001 | Param Invalid | pageを0にできません |
30001 | Param Invalid | sizeを0にできません |
30001 | Permission Denied | 認証時間の期間がプランの保存期限を超えています |
30001 | Param Invalid | 認証時間の終了日が認証時間の開始日より前に設定されています |
30001 | Param Invalid | 認証時間の開始日のフォーマットが不正です |
30001 | Param Invalid | 認証時間の終了日のフォーマットが不正です |
30001 | Param Invalid | パラメーターが不正です |
2.7.3 認証レコードの表示 (/api/v4/record/list)
概要
認証レコードを表示します。
v3のインターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://link.japancv.co.jp/api/v4/record/list
リクエスト方法
GET
リクエストパラメーター
パラメーター名 | 型 | 必須 | 説明 |
date_time_from | string | No | 認証時間の開始日。デフォルト値は現在の日付の0時。 例 : 2018-07-20 12:30:45 |
date_time_to | string | No | 認証時間の終了日。デフォルト値は現在の日付の 23:59:59。 例 : 2019-07-20 12:30:45 |
order | int | No | 並び順 0 : 認証時間で降順 1 : 認証時間で昇順 |
page | int | No | ページ番号(デフォルトは1) |
size | int | No | 1ページあたりのデータの数(デフォルトは 20)。最大値は100 |
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
レスポンスのフィールド
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
data | object | データ |
dataフィールドの説明
パラメーター名 | 型 | 説明 |
list | list<recordItem> | 認証レコード詳細 |
total | int | 認証レコード合計数 |
recordItem フィールドの説明
パラメーター名 | 型 | 説明 |
id | int | 認証レコードID |
direction | int | デバイスのアクセス方向 |
latitude | double | 緯度 |
longitude | double | 経度 |
address | string | 住所 |
location | string | 勤務地 |
mobile | string | 携帯電話番号 |
remark | string | 特記事項 |
groups | list<group> | グループ |
capture_picture | string | 認証時にデバイスが撮影した写真(サムネイル)のID |
capture_bg_picture | string | 認証時にデバイスが撮影した写真(大)のID |
avatar | string | 認証用顔写真 |
heat_avatar | string | 認証時にデバイスが撮影したサーマル画像 |
user_id | int | 登録者ID |
user_name | string | 登録者名 |
user_type | int | 登録者タイプ |
group_id | int | グループID |
group_name | string | グループ名 |
device_name | string | デバイス名 |
device_ldid | string | デバイスLDID |
sign_time | string | 認証時間 |
country_code | (非サポートのパラメータ) | |
place_code | (非サポートのパラメータ) | |
on_business | (非サポートのパラメータ) | |
entry_mode | int | 認証モード |
sign_time_zone | string | タイムゾーン |
verify_score | float | 認証スコア |
mis_id | int | 誤認証ID |
mis_type | int | 誤認証タイプ |
doc_photo | string | IDカード写真(利用できません) |
ic_number | string | ICカード番号 |
id_number | string | IDカード番号読み込み(利用できません) |
abnormal_type | int | 異常レコードタイプ 0:なし 10001:IDカード不一致 10002:認証カード不一致 10003:認証コード不一致 20001:ビジターが有効期限外 20002:アクセス時間外 30001:無効なIDカード 30002:無効なICカード 30003:無効なQRコード 40001:体温が異常 50001:マスク着用無し |
job_number | string | 従業員ID |
user_ic_number | string | 登録者ICカード番号 |
user_id_number | string | 登録者ID番号 |
reception_user_id | long | 受付担当者ID |
reception_user_name | string | 受付担当者名 |
user_remark | string | 登録者コメント |
sign_date | string | 認証日 |
body_temperature | float | 体温 |
mask | int | マスク着用識別子 0:不明 1:着用なし 2:着用あり |
group フィールドの説明
パラメーター名 | 型 | 説明 |
id | long | グループID |
name | string | グループ名 |
type | int | グループタイプ |
エラーレスポンスのフィールド
コード | メッセージ | 説明 |
30001 | Param Invalid | 1回の最大抽出レコード数100を超えています |
30001 | Param Invalid | pageを0にできません |
30001 | Param Invalid | sizeを0にできません |
30001 | Permission Denied | 認証時間の期間がプランの保存期限を超えています |
30001 | Param Invalid | 認証時間の終了日が認証時間の開始日より前に設定されています |
30001 | Param Invalid | 認証時間の開始日のフォーマットが不正です |
30001 | Param Invalid | 認証時間の終了日のフォーマットが不正です |
30001 | Param Invalid | ページが大きすぎます |
2.7.4 認証レコードの表示 (/api/v3/record/list)
概要
認証レコードを表示します。
リクエストアドレスの例
https://link.japancv.co.jp/api/v3/record/list
リクエスト方法
GET
リクエストパラメーター
パラメーター名 | 型 | 必須 | 説明 |
start_record_id | long | No | 認証レコード の開始ID |
end_record_id | long | No | 認証レコード の終了ID |
device_sn | string | No | デバイスシリアル番号 |
type | int | No | タイプ 1:従業員 2:ビジター 3:未登録人物 5 : 拒否リスト |
user_id | long | No | 登録者ID |
date_time_from | string | No | 認証時間の開始日。デフォルト値は現在の日付の 0 時。 例 : 2018-07-20 12:30:45 |
date_time_to | string | No | 認証時間の終了日。デフォルト値は現在の日付の 23:59:59。 例 : 2019-07-20 12:30:45 |
name | string | No | 登録者名 |
page | int | No | ページ番号(デフォルトは 1 です) |
size | int | No | 1 ページあたりのデータの数(デフォルトは 20)。最大値は 100 |
entry_mode | int | No | 認証モード 1:顔認証 2:QR コード 3:カード 4:顔認証とカード 5 : ID カード 6:顔認証と ID カード(1:顔認証のみ利用できます) |
user_id | long | No | 登録者ID |
group_id | long | No | グループID |
mis_type | int | No | 誤認証タイプ 1:別の人物 2:未登録人物 3:非生体 4:未登録人物からの攻撃 5:非生体からの攻撃 |
abnormal_types | int | No | 認証レコードの以上検知タイプ 0:なし 10001:IDカード不一致 10002:認証カード不一致 10003:認証コード不一致 20001:ビジターが有効期限外 20002:アクセス時間外 30001:無効な ID カード 30002:無効な IC カード 30003:無効な QR コード 40001:体温が異常 50001:マスク着用無し |
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
レスポンスのフィールド
パラメーター名 | 型 | 説明 |
code | int | リターンコード |
message | string | リターンメッセージ |
data | object | データ |
dataフィールドの説明
パラメーター名 | 型 | 説明 |
total | int | 総計 |
size | int | 容量 |
data | object | 認証レコードの情報 |
page_num | int | 現在のページ番号 |
page_size | int | ページサイズ |
total_page | int | ページ合計 |
data.dataフィールドの説明
パラメーター名 | 型 | 説明 |
total | int | 総計 |
user_count | int | 従業員レコードの数 |
guest_count | int | ビジターレコードの数 |
stranger_count | int | 未登録者レコードの数 |
record_list | list<recordItem> | 認証レコード |
recordItem フィールドの説明
パラメーター名 | 型 | 説明 |
id | int | 認証レコードID |
direction | int | デバイスのアクセス方向 |
latitude | double | 緯度 |
longitude | double | 経度 |
address | string | 住所 |
location | string | 勤務地 |
mobile | string | 携帯電話番号 |
remark | string | 特記事項 |
groups | list<group> | グループ |
capture_picture | string | 認証時にデバイスが撮影した写真(サムネイル)のID |
capture_bg_picture | string | 認証時にデバイスが撮影した写真(大)のID |
avatar | string | 認証用顔写真 |
heat_avatar | string | 認証時にデバイスが撮影したサーマル画像 |
user_id | int | 登録者ID |
user_name | string | 登録者名 |
user_type | int | 登録者タイプ |
group_id | int | グループID |
group_name | string | グループ名 |
device_name | string | デバイス名 |
device_ldid | string | デバイスLDID |
sign_time | string | 認証時間 |
country_code | (非サポートのパラメータ) | |
place_code | (非サポートのパラメータ) | |
on_business | (非サポートのパラメータ) | |
entry_mode | int | 認証モード |
sign_time_zone | string | タイムゾーン |
verify_score | float | 認証スコア |
mis_id | int | 誤認証ID |
mis_type | int | 誤認証タイプ |
doc_photo | string | IDカード写真(利用できません) |
ic_number | string | ICカード番号 |
id_number | string | IDカード番号読み込み(利用できません) |
abnormal_type | int | 異常レコードタイプ 0:なし 10001:IDカード不一致 10002:認証カード不一致 10003:認証コード不一致 20001:ビジターが有効期限外 20002:アクセス時間外 30001:無効な ID カード 30002:無効な IC カード 30003:無効な QR コード 40001:体温が異常 50001:マスク着用無し |
job_number | string | 従業員ID |
user_ic_number | string | 登録者ICカード番号 |
user_id_number | string | 登録者ID番号 |
reception_user_id | long | 受付担当者ID |
reception_user_name | string | 受付担当者名 |
user_remark | string | 登録者コメント |
sign_date | string | 認証日 |
body_temperature | float | 体温 |
mask | int | マスク着用識別子 0:不明 1:着用なし 2:着用あり |
group フィールドの説明
パラメーター名 | 型 | 説明 |
id | long | グループID |
name | string | グループ名 |
type | int | グループタイプ |
エラーレスポンスのフィールド
コード | メッセージ | 説明 |
30001 | Param Invalid | 1回の最大抽出レコード数100を超えています |
30001 | Param Invalid | ページが大きすぎます |
30001 | Permission Denied | 認証時間の期間がプランの保存期限を超えています |
30001 | Param Invalid | 認証時間の終了日が認証時間の開始日より前に設定されています |
30001 | Param Invalid | 認証時間の開始日のフォーマットが不正です |
30001 | Param Invalid | 認証時間の終了日のフォーマットが不正です |
最終更新