AmpleTrails API Document Essl

The document provides documentation for the AmpleTrails Biometric Solutions API. It outlines prerequisites for accessing the API, including needing an eTime database. It describes the API request/response formats as JSON. It details two API endpoints - one to fetch biometric logs data between dates and another to fetch data after a maximum attendance log index. Both APIs return log data like employee name, date, time, location in JSON response format.

Uploaded by

Manikandan

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

190 views

AmpleTrails API Document Essl

Uploaded by

Manikandan

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 8

AmpleTrails Biometric Solutions

API Documentation
Version 2.0

ESSL WEB API | www.ampletrails.com

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

ESSL WEB API | www.ampletrails.com

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

ESSL WEB API | www.ampletrails.com

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

ESSL WEB API | www.ampletrails.com

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 (DateTime): from when the logs to be send.
• EndDate (DateTime): until when the logs to be send.

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",

ESSL WEB API | www.ampletrails.com

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"
}
]

ESSL WEB API | www.ampletrails.com

AmpleTrails Biometric Solutions

2. 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&Atte
ndanceYear=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.