2.8 レコードの API

2.8.1 認証レコードの表示 (/api/v3/record/list)

概要

認証レコードを表示します。

リクエストアドレスの例

https://HOST:PORT/api/v3/record/list

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

start_record_id

long

認証レコードの開始ID

end_record_id

long

認証レコードの終了ID

device_sn

string

デバイスシリアル番号

type

int

タイプ

1：従業員

2：ビジター

3：未登録人物

5 : ブラックリスト

user_id

long

登録者ID

date_time_from

string

ローカル時間の開始日。デフォルト値は現在の日付の 0 時。例 : 2018-07-20 12:30:45

date_time_to

string

ローカル時間の終了日。デフォルト値は現在の日付の 23:59:59。例 : 2019-07-20 12:30:45

name

string

登録者名

page

int

ページ番号（デフォルトは 1 です）

size

int

1 ページあたりのデータの数（デフォルトは 20）。最大値は 100

entry_mode

int

認証モード

1：顔認証

2：QR コード

3：カード

4：顔認証とカード

5 : ID カード

6：顔認証と ID カード（1：顔認証のみ利用できます）

user_id

long

登録者ID

group_id

long

グループID

mis_type

int

誤認証タイプ

1：別の人物

2：未登録人物

3：非生体

4：未登録人物からの攻撃

5：非生体からの攻撃

abnormal_types

int

認証レコードの以上検知タイプ。 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": 200,
    "message": "OK",
    "data": {
        "total": 118,
        "size": 3,
        "data": {
            "total": 118,
            "user_count": 35,
            "guest_count": 0,
            "stranger_count": 65,
            "record_list": [
                    {
                    "id": 1361801,
                    "direction": 0,
                    "latitude": null,
                    "longitude": null,
                    "address": null,
                    "location": "306lsh",
                    "remark": null,
                    "mobile": "",
                    "groups": [
                        {
                            "id": 1,
                            "name": "Default group",
                            "type": 1,
                            "devices": null,
                            "is_default": null
                        }
                    ],
                    "capture_picture": "5d886e584bb1c40001ad458e",
                    "capture_bg_picture": "5d886e584bb1c40001ad458f",
                    "avatar": "5d7a680a4bb1c40001ac80f6",
                    "heat_avatar":null,
                    "user_id": 100100,
                    "user_name": "Liping Xiao アップデート",
                    "user_type": 1,
                    "group_id": null,
                    "group_name": null,
                    "device_name": "lsh02",
                    "device_ldid": "SPS-257bfefb52b1b88237d195c1ad944063",
                    "sign_time": 1569222232,
                    "country_code": null,
                    "place_code": null,
                    "on_business": 0,
                    "entry_mode": 1,
                    "sign_time_zone": "GMT+08:00",
                    "verify_score": null,
                    "mis_id": null,
                    "mis_type": null,
                    "doc_photo": "",
                    "ic_number": "",
                    "id_number": "",
                    "abnormal_type": null，
                    "job_number": "",
                    "user_ic_number": "",
                    "user_id_number": "",
                    "reception_user_id": 0,
                    "reception_user_name": "",
                    "sign_date": 2019-11-26",
                    "user_remark": ""，
                    "body_temperature": 37.3，
                    "mask":1
                    }
                }
            ]
        },
        "page_num": 1,
        "page_size": 3,
        "total_page": 40
    }
}

レスポンスのフィールド

パラメーター名

型

説明

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 フィールドの説明

パラメーター名

型

説明

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

認証時間

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 フィールドの説明

パラメーター名

型

説明

long

グループID

name

string

グループ名

type

int

グループタイプ

前へ2.7 アクセスルールAPI 次へ2.9 認証用顔写真の API

最終更新 2 年前