AmpleTrails Biometric Solutions

API Documentation SO
Version 6.0
 AmpleTrails Biometric Solutions

CONTENTS

1. Overview
a. Prerequisites
b. Support
2. Interface Specifications
a. API Request
b. API Response
c. API Exception
3. Web API’s
1. Fetch Biometric Logs Data Between Dates
2. Fetch Biometric Logs Data After Maximum Attendance Log Index
 AmpleTrails Biometric Solutions

OVERVIEW
a) Prerequisites
Below are the following details required to access AmpleTrails API’s.
• eTime database.

This can be used in variety of Languages to access REST API’s like .Net, JAVA etc.

b) Support
In case for any clarifications, Please get in touch with the API Support
with Ampletrails team
 AmpleTrails Biometric Solutions

SPECIFICATIONS
The API uses Http Requests to receive data and send responses in JSON format.

a) API Request:
An API request lets you contact a server with API endpoints that you want to
reach and perform some action. Those actions are HTTP methods.

b) API Response:
An API response consists of the body, headers, and the status code.

c) API Exception:
if there is an exception during the processing of the request then the
application will send the response in the following
 AmpleTrails Biometric Solutions

WEB API’S
1. Fetch Biometric Logs Data Between Dates

Method: GET
http://abc.com/api/WebAPI/GetAttendanceBetweenDates

Example:
http://abc.com/api/WebAPI/GetAttendanceBetweenDates?AppKey=6432467912&StartDate=07/01/2020
9:12&EndDate=07/01/2020 20:02

Request JSON Object

• AppKey (String): To access the API method.
• StartDate (Date): from when the logs to be sent.
• EndDate (Date): until when the logs to be sent.

Response JSON data:

[

{
"DeviceLogId": "1",
"DeviceId": "23",
"UserId": "102",
"EmployeeCode": "102",
"EmployeeName": "Satya Ranjan Das",
"LogDate": "7/1/2020 9:04:09 AM",
"DownloadDate": "7/1/2020 9:04:20 AM",
"AttendanceDate": "01 Jul 2020",
"AttendanceTime": "09:04",
"Location": "PMKK Silchar",
"Direction": "",
"AttDirection": "",
"DeviceName": null,
"SerialNumber": "BJ2C190460658",
"IpAddress": "192.168.2.201",
"Status": "Success"
},
{
"DeviceLogId": "2",
"DeviceId": "21",
"UserId": "288",
"EmployeeCode": "288",
"EmployeeName": "Lalbiaksanga",
 AmpleTrails Biometric Solutions

"LogDate": "7/1/2020 9:19:33 AM",

"DownloadDate": "7/1/2020 9:19:32 AM",
"AttendanceDate": "01 Jul 2020",
"AttendanceTime": "09:19",
"Location": "PMKK AIZWAL",
"Direction": "",
"AttDirection": "",
"DeviceName": null,
"SerialNumber": "BJ2C193060915",
"IpAddress": "192.168.101.11",
"Status": "Success"
}
]

2. Fetch Biometric Logs Data Between DateTime

Method: GET
http://abc.com/api/WebAPI/GetAttendanceBetweenDatesTime

Example:
http://abc.com/api/WebAPI/GetAttendanceBetweenDatesTime?AppKey=6432467912&StartDateTime=07/01/2020
09:12:00&EndDateTime=07/01/2020 20:02:00
 AmpleTrails Biometric Solutions

Request JSON Object

• AppKey (String): To access the API method.
• StartDateTime (DateTime): from when the logs to be sent.
• EndDateTime (DateTime): until when the logs to be sent.

Response JSON data:

[

{
"DeviceLogId": "1",
"DeviceId": "23",
"UserId": "102",
"EmployeeCode": "102",
"EmployeeName": "Satya Ranjan Das",
"LogDate": "7/1/2020 9:04:09 AM",
"DownloadDate": "7/1/2020 9:04:20 AM",
"AttendanceDate": "01 Jul 2020",
"AttendanceTime": "09:04",
"Location": "PMKK Silchar",
"Direction": "",
"AttDirection": "",
"DeviceName": null,
"SerialNumber": "BJ2C190460658",
"IpAddress": "192.168.2.201",
"Status": "Success"
},
{
"DeviceLogId": "2",
"DeviceId": "21",
"UserId": "288",
"EmployeeCode": "288",
"EmployeeName": "Lalbiaksanga",
"LogDate": "7/1/2020 9:19:33 AM",
"DownloadDate": "7/1/2020 9:19:32 AM",
"AttendanceDate": "01 Jul 2020",
"AttendanceTime": "09:19",
"Location": "PMKK AIZWAL",
"Direction": "",
"AttDirection": "",
"DeviceName": null,
"SerialNumber": "BJ2C193060915",
"IpAddress": "192.168.101.11",
"Status": "Success"
}
]
 AmpleTrails Biometric Solutions

3. Fetch Biometric Logs Data After Maximum Attendance Log Index

Method: GET
http:/abc.com/api/WebAPI/GetAttendanceBetweenDates

Example:
http://abc.com/api/WebAPI/GetAttendanceAfterIndex?AppKey=6432467912&AttendanceMonth=7&Attendance
Year=2020&AttendanceAfterIndex=70

Request JSON Object

• AppKey (String): To access the API method.
• AttendanceMonth (String): Month for which records are to be fetched.
• AttendanceYear (String): Year for which records are to be fetched.
• AttendanceAfterIndex (String): Last attendance log index id after which records are
to be fetched.

Response JSON data:

[

{
"DeviceLogId": "1",
"DeviceId": "23",
"UserId": "102",
"EmployeeCode": "102",
"EmployeeName": "Satya Ranjan Das",
"LogDate": "7/1/2020 9:04:09 AM",
"DownloadDate": "7/1/2020 9:04:20 AM",
"AttendanceDate": "01 Jul 2020",
"AttendanceTime": "09:04",
"Location": "PMKK Silchar",
"Direction": "",
"AttDirection": "",
"DeviceName": null,
"SerialNumber": "BJ2C190460658",
"IpAddress": "192.168.2.201",
"Status": "Success"
},
{
"DeviceLogId": "2",
"DeviceId": "21",
"UserId": "288",
"EmployeeCode": "288",
"EmployeeName": "Lalbiaksanga",
"LogDate": "7/1/2020 9:19:33 AM",
"DownloadDate": "7/1/2020 9:19:32 AM",
 AmpleTrails Biometric Solutions

"AttendanceDate": "01 Jul 2020",

"AttendanceTime": "09:19",
"Location": "PMKK AIZWAL",
"Direction": "",
"AttDirection": "",
"DeviceName": null,
"SerialNumber": "BJ2C193060915",
"IpAddress": "192.168.101.11",
"Status": "Success"
}
]

4. Attendance Details In Out Work Duration

Method: GET
http://abc.com/api/WebAPI/GetAttendanceInOutDetailed

Example:

http://abc.com/api/WebAPI/GetAttendanceInOutDetailed?AppKey=6432467912&StartDate=2022-09-
01&EndDate=2022-09-30
 AmpleTrails Biometric Solutions

Request JSON Object

• AppKey (String): To access the API method.
• StartDate (DateTime): from when the logs to be send.
• EndDate (DateTime): until when the logs to be send.

Response JSON data:

[
{
"AttendanceLogId": "3576",
"EmployeeCode": "419",
"EmployeeCodeInDevice": "419",
"EmployeeName": "gopi",
"LocationName": "Hostel",
"AttendanceDate": "2022-09-01",
"InTime": "2022-09-01 08:09:43",
"OutTime": "2022-09-01 12:52:55",
"DetailedStatus": "Present",
"DetailedStatusCode": "P",
"LateBy": "10",
"EarlyBy": "427",
"WorkDurationInHHMM": "04:43",
"WorkDurationInMinutes": "283",
"Status": "Success"
},
{
"AttendanceLogId": "3571",
"EmployeeCode": "2522",
"EmployeeCodeInDevice": "2522",
"EmployeeName": "2522",
"LocationName": "None",
"AttendanceDate": "2022-09-01",
"InTime": "1900-01-01 00:00:00",
"OutTime": "1900-01-01 00:00:00",
"DetailedStatus": "Did not come",
"DetailedStatusCode": "A",
"LateBy": "0",
"EarlyBy": "0",
"WorkDurationInHHMM": "00:00",
"WorkDurationInMinutes": "0",
"Status": "Success"
}
]
 AmpleTrails Biometric Solutions

5. Biometric Devices List

Method: GET
http://abc.com/api/WebAPI/GetBiometricDevicesListSO

Example:

http://abc.com/api/WebAPI/GetBiometricDevicesListSO?AppKey=6432467912

Request JSON Object

• AppKey (String): To access the API method.

Response JSON data:

[
{
"DeviceId": "50",
"OnlineOfflineStatus": "Offline",
"DeviceFName": "Hyderabad LB Nagar Impaired",
"DeviceSName": "Hyderabad LB Nagar Impaired",
"DeviceDirection": "Alternate In\\Out Device",
"SerialNumber": "84E0F426F46EAA01",
"DeviceIpAddress": "192.168.0.128",
"LastLogDownloadDate": "11/27/2024 12:21:13 AM",
"LastPingDate": "11/27/2024 12:28:10 AM",
"DeviceType": "Attendance",
"UserCount": "1210",
"FingerPrintCount": "0",
"AttendanceLogsCount": "0",
"OfflineDays": "97",
"OfflineHours": "2339",
"OfflineMinutes": "140351",
"Status": "Success"
},
{
"DeviceId": "51",
"OnlineOfflineStatus": "Online",
"DeviceFName": "Hyderabad Secunderabad",
"DeviceSName": "Hyderabad Secunderabad",
"DeviceDirection": "Alternate In\\Out Device",
"SerialNumber": "84E0F427A2BEAA01",
"DeviceIpAddress": "192.168.0.129",
"LastLogDownloadDate": "3/4/2025 11:19:08 AM",
"LastPingDate": "3/4/2025 11:39:02 AM",
"DeviceType": "Attendance",
"UserCount": "1203",
"FingerPrintCount": "0",
"AttendanceLogsCount": "0",
"OfflineDays": "0",
 AmpleTrails Biometric Solutions

"OfflineHours": "0",
"OfflineMinutes": "0",
"Status": "Success"
}
]

Postman:

6. Biometric Devices Online/Offline Status

Method: GET
http://abc.com/api/WebAPI/GetBiometricDeviceOnlineStatusSO

Example:
http://abc.com/api/WebAPI/GetBiometricDeviceOnlineStatusSO?AppKey=6432467912&
BiometricSerialNumber=84E0F426FB32AA01

Request JSON Object

• AppKey (String): To access the API method.
• BiometricSerialNumber (String): Serial Number of the device.
 AmpleTrails Biometric Solutions

Response JSON data:

{
"DeviceId": "49",
"OnlineOfflineStatus": "Offline",
"DeviceFName": "Hyderabad Kukatpally Impaired",
"DeviceSName": "Hyderabad Kukatpally Impaired",
"DeviceDirection": "Alternate In\\Out Device",
"SerialNumber": "84E0F426FB32AA01",
"DeviceIpAddress": "192.168.0.127",
"LastLogDownloadDate": "12/23/2024 8:21:39 PM",
"LastPingDate": "12/23/2024 8:22:13 PM",
"DeviceType": "Attendance",
"UserCount": "1451",
"FingerPrintCount": "0",
"AttendanceLogsCount": "0",
"OfflineDays": "71",
"OfflineHours": "1695",
"OfflineMinutes": "101701",
"Status": "Success"
}

Postman:
 AmpleTrails Biometric Solutions

7. Device Commands List

Method: GET
http://abc.com/api/WebAPI/GetDeviceCommandsAllSO

Example:

http://abc.com/api/WebAPI/GetDeviceCommandsAllSO?AppKey=6432467912&StartDate=2025-02-
22&EndDate=2025-02-27

Request JSON Object

• AppKey (String): To access the API method.
• StartDate (DateTime): from when the logs to be checked.
• EndDate (DateTime): until when the logs to be checked.

Response JSON data:

[
{
"DeviceCommandId": "1",
"Title": "Upload User Sam kumar A",
"DeviceCommand": "person/create",
"SerialNumber": null,
"CommandStatus": "Success",
"ReturnValue": "LAN_SUS-0-->Personnel information added successfully",
"HDeviceCommand": "person/create",
"CreationDate": "3/3/2025 3:43:21 AM",
"ExecutionDate": "3/3/2025 3:50:35 AM",
"Status": "Success"
},
{
"DeviceCommandId": "2",
"Title": "Upload User Ashwin S",
"DeviceCommand": "person/create",
"SerialNumber": null,
"CommandStatus": "Success",
"ReturnValue": "LAN_SUS-0-->Personnel information added successfully",
"HDeviceCommand": "person/create",
"CreationDate": "3/3/2025 4:10:17 AM",
"ExecutionDate": "3/3/2025 4:19:35 AM",
"Status": "Success"
}

]
 AmpleTrails Biometric Solutions

Postman:

8. Device Commands List Old

Method: GET
http://abc.com/api/WebAPI/GetDeviceCommandsOldSO

Example:

http://abc.com/api/WebAPI/GetDeviceCommandsOldSO?AppKey=6432467912&StartDate=2024-02-
22&EndDate=2025-02-27

Request JSON Object

• AppKey (String): To access the API method.
• StartDate (DateTime): from when the logs to be checked.
• EndDate (DateTime): until when the logs to be checked.
 AmpleTrails Biometric Solutions

Response JSON data:

[
{
"DeviceCommandId": "10410",
"Title": "Upload User CHAITANYA BHOSLE",
"DeviceCommand": "person/update",
"SerialNumber": null,
"CommandStatus": "Success",
"ReturnValue": "LAN_SUS-0-->Personnel information updated
successfully",
"CreationDate": "3/3/2025 1:13:47 AM",
"ExecutionDate": "3/3/2025 1:14:14 AM",
"Status": "Success"
},
{
"DeviceCommandId": "10411",
"Title": "Upload User Sahil Bholanath Gupta",
"DeviceCommand": "person/update",
"SerialNumber": null,
"CommandStatus": "Success",
"ReturnValue": "LAN_SUS-0-->Personnel information updated
successfully",
"CreationDate": "3/3/2025 1:13:57 AM",
"ExecutionDate": "3/3/2025 1:14:24 AM",
"Status": "Success"
},
{
"DeviceCommandId": "10412",
"Title": "Upload User Chaitanya Jalinder Bhosle",
"DeviceCommand": "person/update",
"SerialNumber": null,
"CommandStatus": "Success",
"ReturnValue": "LAN_SUS-0-->Personnel information updated
successfully",
"CreationDate": "3/3/2025 1:14:06 AM",
"ExecutionDate": "3/3/2025 1:14:34 AM",
"Status": "Success"
}
]
 AmpleTrails Biometric Solutions

Postman:

9. ESSL Door Unlock

Method: GET
http://abc.com/api/WebAPI/EbioDoorUnlock

Example:

http://abc.com/api/WebAPI/EbioDoorUnlock?ApiKey=6432467912&BiometricSerialNumber=CNU622266099
2

Request JSON Object:

• AppKey (String): To access the API method.
• BiometricSerialNumber: Device Serial Number
 AmpleTrails Biometric Solutions

Response JSON data:

{
"EsslResponse": "Door Unlock Request Sent",
"CommandID": "Not Applicable",
"Status": "Success"
}

Postman:

10. Add Employee To Biometric Device

Method: POST

http://abc.com/api/WebAPI/AddEmployeeToBiometricSo

Example:
http://abc.com/api/WebAPI/AddEmployeeToBiometricSo?AppKey=6432467912&EmployeeName=Sachin
5&EmployeeCode=2025005&CardNumber&BiometricSerialNumber=JNP2245200305
 AmpleTrails Biometric Solutions

Parameters:
• AppKey (String): To access the API method.
• EmployeeName (String): Name of Employee
• EmployeeCode (String): Employee Code
• CardNumber (String): Card Number

• BiometricSerialNumber (String): Serial Number of Biometric Device

Response:
{
"SoResponse": "Command Send Successfully",
"Status": "Success"
}

Postman:
 AmpleTrails Biometric Solutions

11. Set Employee Validity/Expiration in Biometric Device

Method: GET

http://abc.com/api/WebAPI/SetEmployeeValidityInBiometricSo

Example:
http://abc.com/api/WebAPI/SetEmployeeValidityInBiometricSo?AppKey=6432467912&EmployeeCode=20
25005&BiometricSerialNumber=JNP2245200305&ExpirationDate=2023-01-04

Parameters:
• AppKey (String): To access the API method.
• BiometricSerialNumber (String): Serial Number of Biometric Device
• EmployeeCode (String): Employee Code
• ExpirationDate (String): YYYY-MM-DD

Response:
{
"SoResponse": "Command Send Successfully.",
"Status": "Success"
}
 AmpleTrails Biometric Solutions

Postman:

12. Set Delete Employee From Biometric Device

Method: GET
http://abc.com/api/WebAPI/DeleteUserFromBiometricSo

Example:
http://abc.com/api/WebAPI/DeleteUserFromBiometricSo?AppKey=6432467912&EmployeeCode=2025005
&BiometricSerialNumber=JNP2245200305

Parameters:
• AppKey (String): To access the API method.
• BiometricSerialNumber (String): Serial Number of Biometric Device
• EmployeeCode (String): Employee Code

Response:
{
"SoResponse": "Command Send Successfully",
"Status": "Success"
}
 AmpleTrails Biometric Solutions

Postman:

13. Upload Employee Photo in Biometric Device

Method: GET
http://abc.com/api/WebAPI/PhotoUploadInBiometricSo

Example:
http://abc.com/api/WebAPI/PhotoUploadInBiometricSo?AppKey=6432467912&EmployeeCode=2025006
&BiometricSerialNumber=E03C1CB3018BAA02&Employee_Name=Sachin

Parameters:
• AppKey (String): To access the API method.
• BiometricSerialNumber (String): Serial Number of Biometric Device
• EmployeeCode (String): Employee Code
• Employee_Name (String): Name of Employee

Response:
{
"SoResponse": "Upload Command Send Successfully.",
"Status": "Success"
 AmpleTrails Biometric Solutions

Postman:
 AmpleTrails Biometric Solutions

14. Block/Unblock User in Biometric Device

Method: GET
http://abc.com/api/WebAPI/BlockUserInBiometricSo

Example:

http://abc.com/api/WebAPI/BlockUserInBiometricSo?AppKey=6432467912&BiometricSerialNumber=JNP
2245200305&EmployeeCode=2025005&BlockUser_BL_0_UN_1=0

Parameters:
• AppKey (String): To access the API method.
• BiometricSerialNumber (String): Serial Number of Biometric Device
• EmployeeCode (String): Employee Code
• BlockUser_BL_0_UN_1 (String): 0 – to block the user, 1 – to unblock the user.

Response:
{
"SoResponse": "Command Send Successfully.",
"Status": "Success"
}
 AmpleTrails Biometric Solutions

15. Get All Employees Details

Method: GET
http://abc.com/api/WebAPI/GetEmployeesDetailsSO

Example:
http://abc.com/api/WebAPI/GetEmployeesDetailsSO?AppKey=6432467912&Status_Working_Resigned=W
orking

Parameters:
• AppKey (String): To access the API method.
• Status_Working_Resigned (String): Working/Resigned.

Response:
[
{
"EmployeeName": "Akash Malik",
"EmployeeCode": "AB123",
"EmployeeCodeInDevice": "AB123",
"Gender": "Male",
"CompanyName": "Beejapuri Pvt Ltd",
"DepartmentName": "Pune Pimple",
"DesignationsName": "Default",
"CategoryName": "Default",
"LocationName": "Pune Pimple Saudagar",
"DateOfJoining": "1/31/2025 12:00:00 AM",
"DateOfResignation": "1/1/3000 12:00:00 AM",
"DateOfCreation": "1/31/2025 12:00:00 AM",
"DateOfBirth": "1/1/1900 12:00:00 AM",
"EmploymentTypeName": "Default",
"EmployeeStatus": "Working",
"ContactNo": "",
"Email": "",
"Status": "Success"
},
{
"EmployeeName": "Shreedhar Jain",
"EmployeeCode": "ABC35344",
"EmployeeCodeInDevice": "ABC35344",
"Gender": "Male",
"CompanyName": "Beejapuri Pvt Ltd",
"DepartmentName": "Mumbai Sion",
"DesignationsName": "Bangalore Whitefield",
"CategoryName": "Default",
"LocationName": "Mumbai Sion",
"DateOfJoining": "6/12/2024 12:00:00 AM",
"DateOfResignation": "1/1/3000 12:00:00 AM",
"DateOfCreation": "6/12/2024 12:00:00 AM",
"DateOfBirth": "1/1/1900 12:00:00 AM",
"EmploymentTypeName": "Default",
"EmployeeStatus": "Working",
 AmpleTrails Biometric Solutions

"ContactNo": "",
"Email": "",
"Status": "Success"
}
]

Postman:

16. Get Face/Finger Enrolled count of Employee

Method: GET
http://abc.com/api/WebAPI/GetFaceFingerEnrolledCountEmployeeSO

Example:

http://abc.com/api/WebAPI/GetFaceFingerEnrolledCountEmployeeSO?AppKey=6432467912&EmployeeC
ode=1001

Parameters:
• AppKey (String): To access the API method.
• EmployeeCode (String): Employee Code.
 AmpleTrails Biometric Solutions

Response:
[
{
"EmployeeName": "Himanshu sharma",
"EmployeeCode": "1001",
"EmployeeCodeInDevice": "1001",
"DeviceId": "50",
"BiometricDeviceName": "Hyderabad LB Nagar Impaired",
"FingerFaceCount": "1",
"BioType": "",
"Status": "Success"
},
{
"EmployeeName": "Himanshu sharma",
"EmployeeCode": "1001",
"EmployeeCodeInDevice": "1001",
"DeviceId": "51",
"BiometricDeviceName": "Hyderabad Secunderabad",
"FingerFaceCount": "1",
"BioType": "",
"Status": "Success"
}
]

Postman:
 AmpleTrails Biometric Solutions

17. Get Face/Finger Enrolled count of All Employees

Method: GET
http://abc.com/api/WebAPI/GetFaceFingerEnrolledCountAllSO

Example:

http://abc.com/api/WebAPI/GetFaceFingerEnrolledCountAllSO?AppKey=6432467912&EmployeeCode=10
01

Parameters:
• AppKey (String): To access the API method.

Response:
[
{
"EmployeeName": "Himanshu sharma",
"EmployeeCode": "1001",
"EmployeeCodeInDevice": "1001",
"DeviceId": "86",
"BiometricDeviceName": "Surat Bhatar Road",
"FingerFaceCount": "1",
"BioType": "",
"Status": "Success"
},
{
"EmployeeName": "Hemant Yadav",
"EmployeeCode": "1390",
"EmployeeCodeInDevice": "1390",
"DeviceId": "49",
"BiometricDeviceName": "Hyderabad Kukatpally Impaired",
"FingerFaceCount": "1",
"BioType": "",
"Status": "Success"
},
{
"EmployeeName": "Sumit Kumar",
"EmployeeCode": "1473",
"EmployeeCodeInDevice": "1473",
"DeviceId": "55",
"BiometricDeviceName": "Hyderabad Sainikpuri",
"FingerFaceCount": "1",
"BioType": "",
"Status": "Success"
}
]
 AmpleTrails Biometric Solutions

Postman: