HttpApiClient

HTTP interface implementation

HttpApiClient

Member Function	Description	Version Introduced
byte[] getImage(int type, String imageId)	Get Image Data	2.0.0
ConnectConfigEntity getConnectConfigEntity()	Get Current Connection Configuration	2.0.0
Result alarmReport(AlarmReportParameter reportParameter)	Alarm Report	2.0.0
Result bindDefaultGroup()	bind Default Group	2.0.0
Result checkPasswordUseLoginInterface(String password)	check Password	2.0.0
Result<TslCheckExistResult> checkTslExist(String md5)	check Tsl Exist	2.0.0
Result<TslLanguageCheckExistResult> checkTslLanguageExist(Result checkTslLanguageExist(String lang))(String lang)	check Tsl Language Exist	2.0.0
Result<FaceSearchResult> faceSearch(FaceSearchParameter searchParameter)	Server Identification	2.0.0
Result> getGroupIndexList()	Get Group Index List Bound to the device	2.0.0
Result> getUserIndexList(int groupId)	Get User Index List in a Group	2.0.0
Result> getUserInfoList(UserInfoParameter parameter)	Get User Info List	2.0.0
Result getServiceConfigJson()	Get Server Configuration	2.0.0
Result<DeviceGroups> getAllGroupList()	Get Group List Bound to the Device	2.0.0
Result<DeviceDetailInfo> getDeviceDetailInfo()	Get Device DetaiIed Info	2.0.0
Result<Company> getCompanyInfo()	Get Company Info	2.0.0
Result<UserDetailInfo> getUserInfo(long id)	Get User Detailed Info	2.0.0
Result<GuestDetailInfo> getGuestInfo(long id)	Get Guest Detailed Info	2.0.0
Result<ServerVersion> getServerVersion()	Get Server Version	2.0.0
Result<TimeTable> getPassTimeTable(long timetableId)	Get Pass Time Table	2.0.0
void logout()	logout	2.0.0
Result<QRResult> identifyQRCode(IdentifyQRCodeParameter parameter)	QR Code Identification Interface	2.0.0
Result<LoginResult> login(String account, String password,String identifier, String duid)	Device Login	2.0.0
Result<RegisterResult> register( RegisterParameter registerParameter)	Device Registration	2.0.0
Result reportUserStatus(UserStatusParameter userStatusParameter)	Upload the abnormal status of the user in the local database	2.0.0
Result reportUserStatus(UserSyncStatusParameter userSyncStatusParameter)	Upload the abnormal status of the user in the local database	2.0.0
void refreshConnectConfig(ConnectConfigEntity connectConfig)	refresh Connect Configuration	2.0.0
Result reportDeviceEvent(DeviceReportEventParamer param)	Report Device Status	2.0.0
Result<RecordResult> uploadRecord(RecordParameter recordParameter)	Upload Identification Record	2.0.0
Result uploadDeviceVersionInfo(DeviceVersionInfoParameter deviceInfoParameter)	Upload Device Version Info	2.0.0
Result uploadConfig(String deviceConfigKey, Object config)	Upload Configuration	2.0.0
Result uploadTsl(TslUploadParameter parameter)	upload Tsl	2.0.0
Result uploadTslLanguage(TslLanguageUploadParameter parameter)	upload Tsl Language Package	2.0.0

Description of Member Function

byte[] getImage(int type, String imageId)

Get Image Data

Parameter

Parameter Name	Type	Description	Note	Version Introduced
type	int	Image Type	1-Base Image in Senselink, 2-Recognition Image	2.0.0
imageId	String	Image ID	None	2.0.0

Return

Image Data

Exception

None

ConnectConfigEntity getConnectConfigEntity()

Get Current Connection Configuration

Parameter

None

Return

ConnectConfigEntity

Exception

None

Result alarmReport(AlarmReportParameter reportParameter)

Alarm Report

Parameter

Parameter Name	Type	Description	Note	Version Introduced
reportParameter	AlarmReportParameter	Parameter	None	2.0.0

Return

Result

Exception

None

Result bindDefaultGroup()

Bind Default Group

Parameter

None

Return

Result

Exception

No

Result checkPasswordUseLoginInterface(String password)

Check Password

Parameter

Parameter Name	Type	Description	Note	Version Introduced
password	String	password	None	2.0.0

Return

Result

Exception

None

Result checkTslExist(String md5)

Check Tsl Exist

Parameter

Parameter Name	Type	Description	Note	Version Introduced
md5	String	File md5	None	2.0.0

Return

Result<TslCheckExistResult>

Exception

None

Result checkTslLanguageExist(String lang)

Check Tsl Language Exist

Parameter

Parameter Name	Type	Description	Note	Version Introduced
lang	String	Language	None	2.0.0

Return

Result<TslLanguageCheckExistResult>

Exception

None

Result faceSearch(FaceSearchParameter searchParameter)

Server Identification

Parameter

Parameter Name	Type	Description	Note	Version Introduced
searchParameter	FaceSearchParameter	Parameter	None	2.0.0

Return

Result<FaceSearchResult>

Exception

None

Result> getGroupIndexList()

Get Group Index List Bound to the device

Parameter

None

Return

Result<GroupIndex>

Exception

None

Result> getUserIndexList(int groupId)

Get User Index List in a Group

Parameter

None

Return

Result>

Exception

None

Result> getUserInfoList(UserInfoParameter parameter)

Get User Info List

Parameter

Parameter Name	Type	Description	Note	Version Introduced
parameter	UserInfoParameter	Parameter	None	2.0.0

Return

Result>

Exception

None

Result getServiceConfigJson()

Get Server Configuration

Parameter

None

Return

Result

Exception

None

Result getAllGroupList()

Get Group List Bound to the Device

Parameter

None

Return

Result<DeviceGroups>

Exception

None

Result getDeviceDetailInfo()

Get Device DetaiIed Info

Parameter

None

Return

Result<DeviceDetailInfo>

Exception

None

Result getCompanyInfo()

Get Company Info

Parameter

None

Return

Result<Company>

Exception

No

Result getUserInfo(long id)

Get User Detailed Info

Parameter

Parameter Name	Type	Description	Note	Version Introduced
id	long	User ID	None	2.0.0

Return

Result<UserDetailInfo>

Exception

None

Result getGuestInfo(long id)

Get Guest Detailed Info

Parameter

Parameter Name	Type	Description	Note	Version Introduced
id	long	Guest ID	None	2.0.0

Return

Result<GuestDetailInfo>

Exception

None

Result getServerVersion()

Get Server Version

Parameter

None

Return

Result<ServerVersion>

Exception

None

Result getPassTimeTable(long timetableId)

Get Pass Time Table

Parameter

Parameter Name	Type	Description	Note	Version Introduced
timetableId	long	Pass Time Table ID	None	2.0.0

Return

Result<TimeTable>

Exception

None

void logout()

Log out

Parameter

None

Return

None

Exception

None

Result identifyQRCode(IdentifyQRCodeParameter parameter)

QR Code Identification Interface

Parameter

Parameter Name	Type	Description	Note	Version Introduced
parameter	IdentifyQRCodeParameter	Parameter	None	2.0.0

Return

Result<QRResult>

Exception

None

Result login(String account, String password,String identifier, String duid)

Device Login

Parameter

Parameter Name	Type	Description	Note	Version Introduced
account	String	Device Login Account	None	2.0.0
password	String	Device Login Password	None	2.0.0
identifier	String	Device Identifier	None	2.0.0
duid	String	Device sn	None	2.0.0

Return

Result<LoginResult>

Exception

None

Result register( RegisterParameter registerParameter)

Device Registration

Parameter

Parameter Name	Type	Description	Note	Version Introduced
registerParameter	RegisterParameter	Parameter	None	2.0.0

Return

Result<RegisterResult>

Exception

None

Result reportUserStatus(UserStatusParameter userStatusParameter)

Upload the abnormal status of the user in the local database

Parameter

Parameter Name	Type	Description	Note	Version Introduced
userStatusParameter	UserStatusParameter	Parameter	None	2.0.0

Return

Result

Exception

None

Result reportUserStatus(UserSyncStatusParameter userSyncStatusParameter)

Upload the abnormal status of the user in the local database

Parameter

Parameter Name	Type	Description	Note	Version Introduced
userSyncStatusParameter	UserSyncStatusParameter	Parameter	None	2.0.0

Return

Result

Exception

None

void refreshConnectConfig(ConnectConfigEntity connectConfig)

Refresh Connect Configuration

Parameter

Parameter Name	Type	Description	Note	Version Introduced
connectConfig	ConnectConfigEntity	Configuration	None	2.0.0

Return

None

Exception

None

Result reportDeviceEvent(DeviceReportEventParamer param)

Report Device Event

Parameter

Parameter Name	Type	Description	Note	Version Introduced
param	DeviceReportEventParamer	Parameter	None	2.0.0

Return

Result

Exception

None

Result uploadRecord(RecordParameter recordParameter)

Upload Identification Record

Parameter

Parameter Name	Type	Description	Note	Version Introduced
recordParameter	RecordParameter	Parameter	None	2.0.0

Return

Result<RecordResult>

Exception

None

Result uploadDeviceVersionInfo(DeviceVersionInfoParameter deviceInfoParameter)

Upload Device Version Info

Parameter

Parameter Name	Type	Description	Note	Version Introduced
deviceInfoParameter	DeviceVersionInfoParameter	Parameter	None	2.0.0

Return

Result

Exception

None

Result uploadConfig(String deviceConfigKey, Object config)

Upload Configuration

Parameter

Parameter Name	Type	Description	Note	Version Introduced
deviceConfigKey	String	Device config key	None	2.0.0
config	Object	config Configuration	None	2.0.0

Return

Result

Exception

None

Result uploadTsl(TslUploadParameter parameter)

Upload Tsl

Parameter

Parameter Name	Type	Description	Note	Version Introduced
parameter	TslUploadParameter	Parameter	None	2.0.0

Return

Result

Exception

None

Result uploadTslLanguage(TslLanguageUploadParameter parameter)

Upload Tsl Language Package

Parameter

Parameter Name	Type	Description	Note	Version Introduced
parameter	TslLanguageUploadParameter	Parameter	None	2.0.0

Return

Result

Exception

None