APIでの登録者操作では顔写真品質チェッのレベル低実施されます。ご注意ください。
2.4.1 従業員の追加 (/api/v1/user)
概要
従業員を追加します。
リクエストアドレスの例
https://HOST:PORT/api/v1/user
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
"data": {
"id": 65838,
"name": "1312313123123122",
"avatar": "5cbe78b135060d0001750ef5",
"mobile": "",
"remark": "",
"type": 1,
"birthday": "",
"mail": null,
"position": null,
"location": null,
"groupList": [
{
"id": 1,
"name": "Default group",
"type": 1
}
],
"gender": 1,
"prompt": "",
"ic_number": "",
"id_number": "te9+d6aXoDe5zTCUywgn9+zmx4HElB4W",
"job_number": "",
"company_id": 1,
"create_at": "2019-04-23 10:30:08",
"update_at": "2019-04-23 10:30:08",
"department_id": 0,
"area_code": null,
"entry_time": "2018-9-10"
}
}
類似登録者が存在する場合のレスポンス
{
"code": 30002,
"message": "Similar User Exist",
"data": {
"similar_user_id": 65833,
"similar_user_name": "11111111",
"similar_user_avatar": "5cbe7dec35060d0001750f15",
"can_force": 0
},
"desc": "ex.similar-user"
}
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
2.4.2 従業員情報の変更 (/api/v2/user/update/{id})
概要
従業員情報を変更します。
バージョン v1 から、従業員ID、IC カード番号、および空の ID 番号の処理ロジックが改善されました。パラメーターが渡されなかった場合やパラメーターが null の場合、変更は行われません。空の string (””) が渡された場合、空として設定されます。バージョン v1 のインターフェースは、引き続きご利用いただくことができます。
リクエストアドレスの例
https://HOST:PORT/api/v2/user/update/{id}
リクエスト方法
POST: form-data
リクエストパラメーター
group フィールドの説明
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
"data": {
"id": 79653,
"name": "1312313123123122",
"avatar": "",
"mobile": "123",
"remark": "",
"type": 1,
"birthday": null,
"mail": null,
"position": null,
"location": null,
"groupList": [{
"id": 1,
"name": "Default group",
"type": 1
}],
"gender": null,
"prompt": null,
"ic_number": "1234000",
"id_number": null,
"job_number": "120003",
"company_id": 1,
"create_at": null,
"update_at": "2019-08-22 11:03:18",
"department_id": null,
"area_code": null,
"entry_time": null,
}
}
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
2.4.3 従業員の削除 (/api/v1/user/delete/{id})
概要
従業員を削除します。
リクエストアドレスの例
https://HOST:PORT/api/v1/user/delete/{id}
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK"
}
レスポンスのフィールド
エラーレスポンスのフィールド
2.4.4 指定された日付(日)に追加、または更新された従業員アバターの取得(/api/v2/staff/image_updated)
概要
指定された日付(日)に追加、または更新された従業員アバターリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/staff/image_updated
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
"data": [
{
"employee_id":"001"
"image_URL": "xxx",
"remark": 0
},
{
"employee_id":"002"
"image_URL": "xxx",
"remark": 1
}
]
}
レスポンスのフィールド
エラーレスポンスのフィールド
2.4.5 ビジターの追加 (/api/v1/guest)
概要
ビジターを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v1/guest
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
"data": {
"id": 79661,
"name": "zml",
"avatar": "5d5e36e4f684640001b34027",
"mobile": "123",
"remark": "",
"groups": [],
"position": null,
"level": null,
"mail": null,
"birthday": null,
"prompt": null,
"gender": null,
"ic_number": "",
"id_number": "kBDHQ/IUQtY=",
"company_id": 1,
"reception_user_id": 4567,
"reception_user_name": "太朗",
"group_count": 0,
"date_time": "2018-07-20 12:30:45.0",
"date_time_from": "2018-07-20 12:30:45.0",
"date_time_to": "2020-07-20 12:30:45.0",
"create_at": "2019-08-22 14:32:04.0",
"update_at": "2019-08-22 6:32:04.0",
"area_code": null,
"guest_company": null,
"guest_purpose": null
}
}
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
2.4.6 ビジター情報の変更 (/api/v1/guest/update/{id})
概要
ビジター情報を変更します。
(すでに登録済みの他者の写真を利用して更新する場合、ビジター情報の変更や顔認証が正常に登録や正常に行われません。ご注意ください。)
リクエストアドレスの例
https://HOST:PORT/api/v1/guest/update/{id}
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
"data": {
"id": 124379,
"name": "zml",
"avatar": "5dad624c199e160001c45e8f",
"mobile": "123",
"remark": "",
"groups": [{
"id": 14,
"name": "Default group",
"type": 2
}],
"position": "",
"level": "",
"mail": "",
"birthday": null,
"prompt": "",
"gender": 2,
"ic_number": "",
"id_number": "kBDHQ/IUQtY=",
"company_id": 12,
"reception_user_id": 124794,
"reception_user_name": "太朗",
"group_count": 1,
"date_time": "2018-07-20 12:30:45",
"date_time_from": "2018-07-20 12:30:45",
"date_time_to": "2020-07-20 12:30:45",
"create_at": "2019-10-21 15:51:28",
"update_at": "2019-10-30 20:45:05",
"area_code": "86",
"guest_company": "",
"guest_purpose": ""
}
}
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
2.4.7 ビジターの削除 (/api/v1/guest/delete/{id})
概要
ビジターを削除します。
リクエストアドレスの例
https://HOST:PORT/api/v1/guest/delete/{id}
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK"
}
レスポンスのフィールド
エラーレスポンスのフィールド
2.4.8 ブラックリストの追加 (/api/v2/black)
概要
ブラックリストを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v2/black
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
"data": {
"id": 66865,
"name": "山田",
"avatar": "5d084f23b2814100015ad03c",
"mobile": "13655588555",
"mail": "1365558@mail.com",
"birthday": "2019-06-11",
"remark": "demo",
"groups": [
{
"id": 126,
"name": "デフォルトブラックリスト",
"type": 3
},
{
"id": 127,
"name": "2",
"type": 3
}
],
"prompt": "ようこそ",
"gender": 0,
"createBy": "OPEN API",
"avatar_show": "",
"ic_number": "",
"id_number": "1545557788555",
"area_code": "86",
"last_type": 0,
"create_at": "2019-06-18 02:40:35.0"
}
}
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
2.4.9 ブラックリストへの移動 (/api/v2/black/move/in)
概要
既存の従業員またはビジターを選択してブラックリストに移動(登録者タイプを変更)します。
ブラックリストに移動した後、登録者タイプがブラックリスト(type = 5) に変更されます。元の登録者グループと部署情報はクリアされますが、他の情報は保持されます。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/move/in
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
}
エラーレスポンスのフィールド
2.4.10 ブラックリストからの削除 (/api/v2/black/move/out)
概要
ブラックリストを削除します。
ブラックリストから外されると、登録者タイプは元の識別子に戻ります(タイプ 1 または 2)。他の情報は保持されます。 ブラックリストの登録者自体を削除するには、「ブラックリストの削除」の章を参照してください。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/move/out
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
}
エラーレスポンスのフィールド
2.4.11 ブラックリストの変更 (/api/v2/black/update)
概要
ブラックリストの情報を変更します。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/update
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
"desc": "",
"data": {
"id": 124759,
"name": "668089",
"avatar": "5dba86ff7bf01300010b02c9",
"mobile": "",
"mail": "",
"birthday": "",
"remark": "",
"groups": [{
"id": 15,
"name": "Blacklist default group",
"type": 5
}],
"prompt": "",
"gender": 2,
"avatar_show": "",
"ic_number": "",
"id_number": "3O8bqu0sRiKA7+LVRzE3eQ==",
"area_code": "86",
"last_type": 0,
"create_by": "admin1234",
"create_at": "2019-10-23 17:28:19"
}
}
レスポンスのフィールド
group フィールド
エラーレスポンスのフィールド
2.4.12 ブラックリストの削除 (/api/v2/black/delete/{id})
概要
ブラックリストを削除します。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/delete/{id}
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
}
エラーレスポンスのフィールド
2.4.13 登録者の参照 (/api/v1/user/list)
概要
従業員、ビジター、およびブラックリストのすべての登録者の情報を取得します。特定のフィールドのフィルター検索が可能です。
リクエストアドレスの例
https://HOST:PORT/api/v1/user/list
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
{
"code": 200,
"message": "OK",
"data": [
{
"id": 67015,
"name": "太郎",
"avatar": "5d0afdde1870ac00019ffffd",
"mobile": "1882960772",
"remark": "",
"type": 1,
"birthday": null,
"mail": "",
"position": "",
"location": "",
"groupList": [
{
"id": 1,
"name": "Default group",
"type": 1
}
],
"gender": 1,
"prompt": "",
"ic_number": "",
"id_number": "",
"job_number": "",
"company_id": 1,
"create_at": "2019-06-20 03:30:37.0",
"update_at": "2019-06-20 03:30:38.0",
"department_id": 0,
"area_code": "86",
"entry_time": null,
"country_code": null,
"place_code": null,
"staff_type": 0,
"reception_user_id": 0,
"date_time_from": "2017-01-01 00:00:00.0",
"date_time_to": "2017-01-01 00:00:00.0",
"avatar_show": null,
"phone_suffix": "",
"guest_company": null,
"guest_purpose": null,
"guest_level": null,
"add_time": "2019-06-20 03:30:38.0",
"guest_auth_status": 1,
"last_type": 0
}
]
}
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド