查询打卡围栏配置信息(API名称:openApiQueryLocationSignConfig)
功能介绍
查询打卡围栏配置信息
相关接口
接口名称 |
调用说明 |
---|---|
调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 |
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
---|---|---|---|
POST |
https://isdp+域名/openapi/v1/locationSignConfig/openApiQueryLocationSignConfig |
OpenAPI |
application/json |
请求头
KEY |
VALUE |
是否必填 |
描述 |
---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
projectNos |
List<String> |
否 |
项目编号集合 |
page |
PageRequest |
否 |
分页对象 |
Page参数
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
start |
Integer |
否 |
分页起始下标 (从0开始) |
count |
Integer |
否 |
查询总条数(最大查询100条) |
响应参数
参数 |
类型 |
描述 |
---|---|---|
stateCode |
String |
响应状态码:
|
errorMessage |
String |
响应描述 |
result |
Object |
响应结果内容data、分页数据 |
result出参:
参数 |
类型 |
描述 |
---|---|---|
pos |
Integer |
起始位置 |
totalCount |
Integer |
总条数 |
lastUpdatedBy |
Long |
最近更新人 |
forceFaceCompar |
Integer |
是否强制身份校验(1:是,2:否) |
lastUpdateDate |
Date |
最近更新日期 |
configFlag |
Integer |
普通打卡围栏配置开关(1:启用,2禁用) |
creationDate |
Date |
创建时间 |
signConfigId |
Long |
打卡配置ID |
photoFileSample |
String |
照片样例:存FILE_ID清单,用逗号隔开 |
photoFlag |
String |
是否允许拍照,Y/N |
projectNo |
String |
项目编码 |
tenantName |
String |
租户名 |
maxPhoto |
Integer |
最多照片数量 |
createdBy |
Long |
创建人 |
faceComparFlag |
Integer |
普通打卡人脸识别开关(1:启用,2禁用) |
tenantId |
Long |
租户ID |
projectName |
String |
项目名字 |
signValidScope |
Integer |
打卡有效范围,单位米 |
forceFenceFlag |
String |
强制围栏标识,Y/N |
crossFencePhotoFlag |
String |
超出围栏强制拍照标识,Y/N |
请求示例
{ "page": { "start": 0, "count": 100 } }
响应示例
{ "data": [ { "signConfigId": 80961, "tenantId": 886, "tenantName": null, "projectNo": "", "projectName": "", "forceFenceFlag": "N", "signValidScope": 1000000000, "crossFencePhotoFlag": "N", "maxPhoto": null, "photoFileSample": "", "photoFlag": null, "createdBy": 391001, "creationDate": "2023-10-19T09:24:14.000+00:00", "lastUpdatedBy": 391001, "lastUpdateDate": "2023-10-19T09:24:14.000+00:00", "configFlag": 2, "faceComparFlag": 2, "forceFaceCompar": 2 } ], "pos": 0, "total_count": 1, "entityName": null, "totalCount": 1 }