App stand-alone Web interface description

Application settings

1. Get current configuration

GET: /api/settings/loadInfo
Request parameters:

Parameter names	Type	Remarks
/	/	/

Back to:

{
"msg": " Operation is successful ",
"code": 0,
"data": {
"binocularLiving": true,
"deviceVolume": 80,
"enablePrinting": false,
"faceAngle": 270,
"faceMirror": false,
"featureThreshold": 75,
"id": 23,
"livenessThreshold": 65,
"living": 1,
"maskDetection": 0,
"multiPersonRecognition": false,
"nearFaceWidth": 125,
"noPictures": true,
"printCharset": "GBK",
"printImage": true,
"runMode": 1,
"screenSaverTime": 30,
"showLogo": false,
"showScreenSaver": false,
"strangersPass": 1,
"tempEnd": 37.3,
"tempStart": 35.9,
"tempUnit": 0,
"temperature": 1,
"temperatureMeasurementTime": 350,
"temperatureMeasuringModule": 2,
"videoAngle": 90,
"videoMirror": false,
"voicePromptType": 1
},
"success": true
}

Field description:

tip:

1. 
   Web-side voice type selection, only select the sound effect and language, if it is customized, please block it.
   
2. 
   The adminPassword field is not returned, and changing the password requires additional processing.
   
3. 
   If the LogoPath field has not uploaded a logo, it will not be display return.
   
4. 
   If the screenSaverPath field has not been uploaded a screensaver, it will not return.
   

3. 
   
   
4. 
   
   
5. 
   
   
6. 
   
   
   1. 
      
      

   2. Submit changes

POST: /api/settings/saveEdit:
Request parameters: application/json

Parameter names	Type	Remarks
Id	Long	Device ID
featureThreshold	int	Feature comparison threshold
deviceVolume	int	Device volume
temperature	int	Temperature measurement switch (0=off, 1=on)
maskDetection	int	Mask detection (0=off, 1=on)
living	int	Living body switch (0=off, 1=on)
strangersPass	int	Strangers pass (0=off, 1=on)
tempStart	double	Normal minimum temperature
tempEnd	double	Normal maximum temperature
temperatureMeasuringModule	int	Temperature measurement module (1 Hikvsion, 2 Heiman, 3 Gaode, 4 Gaolihe)
runMode	int	Operating mode (0=advertisement + temperature measurement + traffic record) 1=Temperature measurement, 2=Advertising + temperature measurement 3=Horizontal mode
videoMirror	boolean	Video stream mirroring
faceMirror	boolean	Face mirroring
videoAngle	int	Video stream angle 0 90 180 270
faceAngle	int	Face angle 0 90 180 270
voicePromptType	int	Voice type (0=sound effect, 1 language)
nearFaceWidth	int	Less than this width, please come closer
screenSaverTime	int	Screen saver time, default 30 seconds
binocularLiving	boolean	Live Binocular
enablePrinting	boolean	Enable printing
livenessThreshold	Int	liveness score
multiPersonRecognition	boolean	Multi-person recognition
noPictures	boolean	Do not save pictures, prohibit photos
printCharset	String	Printer communication code ( GBK, GB2312, GB18030, UTF-8, UTF-16, IOS-8859-1) six formats
printImage	boolean	Print pass pictures at the same time
showLogo	boolean	Switch display Logo
showScreenSaver	boolean	Switch display custom screensaver
tempUnit	Int	Temperature symbol (0=Celsius, 1=Fahrenheit)
temperatureMeasurementTime	Int	Temperature measurement time
logoPath	String	Logo address
screenSaverPath	String	Screen saver address

tips:　

1. 
   nearFaceWidth screenSaverTime not open for modification at the moment.
   
2. 
   adminPassword don't need to pass it, and you need to call another interface to change the password.
   
3. 
   Each call needs to return all the fields returned by loadInfo.
   
4. 
   If the modification is successful, the app will restart.
   

e. If the logo has not been uploaded, the logoPath field will not be displayed, and the logo address will be returned when the upload logo is called. Even if this field is not displayed, you can assign the returned logo address to the logoPath field and submit it.
f. If the screen saver has not been uploaded, the field screenSaverPath will not be displayed. When the upload screen saver method is called, the address of the screen saver will be returned. Even if this field is not displayed, you can assign the returned screen saver address to the screenSaverPath field and submit it.

3. Software update

POST: /api/settings/updateApp
Request parameters: multipart/form-data

Parameter names	Type	Remarks
apkFile	File	Apk文件

Tip: apkFile is the file type in the form, example:

Back to:

{
"msg": "操作成功",
"code": 0,
"success": true
}

如果返回成功, 前端控制10秒倒计时后刷新界面.

4. Modify system time

POST: /api/settings/updateDateTime
Request parameters: x-www-form-urlencoded

Parameter names	Type	Remarks
dateTime	String	yyyy-MM-dd HH:mm:ss

Back to:

{
"msg": "操作成功",
"code": 0,
"success": true
}

6.5 upload logo

POST:/api/settings/uploadLogo
Request parameters: multipart/form-data

Back to：
{
"msg": "OK",
"code": 0,
"data": "/storage/emulated/0/Android/data/com.ceco.face/files/config/logo.png",
"success": true
}
Note: After uploading, the Logo address returned in the data must be assigned to the logoPath field, and then the showLogo field should be set to true, and the configuration can be modified and saved by calling /api/settings/saveEdit.

6.6 upload screensaver

POST:/api/settings/uploadScreenSaver
Request parameters: multipart/form-data

Back to：
{
"msg": "OK",
"code": 0,
"data": "/storage/emulated/0/Android/data/com.ceco.face/files/config/screenSaver.png",
"success": true
}
注意：上传后返回data里的屏保地址，必须要赋值给screenSaverPath字段中，然后把showScreenSaver字段赋值为true在调用/api/settings/saveEdit修改配置保存即可。

3. Attendance management

7.1 Query attendance configuration

GET：/api/attendance/loadInfo
Back to：
{
"code": "",
"msg": "",
"data": {
"workShiftType": 0, //班次类型, 0=一天一班, 1=一班两班, 2=一天三班
"workShifts": [
{
"startTime": "09:00", //上班时间
"endTime": "18:00" //下班时间
}
]
},
"success": "true"
}

7.2 Query attendance records

POST：/api/attendance/listData
Request parameters: application/json

Parameter names	Type	Remarks
userCode	String	搜索输入用户编号内容
startTime	String	开始时间
endTime	String	结束时间

Header

Parameter names	Type	Remarks
pageNum	int	Pagination page number, default is 1
pageSize	Int	How many entries per page, default 30

Back to：
{

"msg": "操作成功",
"code": 0,
"data": {
"data": [
{
"createTime": "2021-03-08 18:38:35",
"devSn": "YGKJ20209240958",
"devUserId": 297,
"exportType": 0,
"id": 1,
"used": false,
"userCode": "006655",
"userName": "ly"
}
],
"pageNum": 1,
"pageSize": 30,
"total": 1
},
"success": true
}

3. Modify the work shift

POST：/api/attendance/saveEdit
Request parameters: application/json

Parameter names	Type	Remarks
workShiftType	Int	0=one shift one day, 1=一two shifts one day, 2=three shifts one day
startTime	String	Start time
endTime	String	End time

body
{

"workShiftType": 0, //班次类型, 0=一天一班, 1=一班两班, 2=一天三班
"workShifts": [
{
"startTime": "", //上班时间
"endTime": "" //下班时间
}
]
}

Back to：
{

"code": "",
"msg": "",
"data": "",
"success": "true"
}
Note: The workShifts array of one shift a day must be one object, the workShifts array of two shifts a day must be two objects, and the workShifts array of three shifts a day must be three objects, which respectively indicate the off-duty time of each shift in order.

3.