eBioServerNew
eSSL eBioserverNew WEB API Service
eSSL-
--- Web API Service Help Manual
Version : eTimetracklite 1.0
Version Date : 28th September, 2023
No. of Pages :
About This Manual: This document introduces the eBioServerNew Web API services
for the user interface and operations of the eBioServer
CONFIDENTIAL Page 1 of 10
eBioServerNew
Table Contents Page
1. Update Employee ______________________ 3
2. Get Employee Details ______________________ 5
3. Get Employee Codes ______________________ 6
4. Get Employee Punch Logs ______________________ 7
5. Delete Employee ____________________
______________________ 8
6. Update Employee Expiry Date ______________________ 9
CONFIDENTIAL Page 2 of 10
eBioServerNew
Web Service URL: URL of eBioserverNew application
(Example: [Link]
[Link]
Methods:
Add Employee (Name:: UpdateEmployee)
Example: [Link] UpdateEmployee
eBioserverNew/[Link]?op=UpdateEmployee
By calling this method wee can add employee to particular location of all the devices by passing
ame, Card Number, Single Location code or Multiple location code
value Employee code, Name,
separated by comma, Employee Role and Verification Type
Result will be displayed as error or success
Note: User name & password can obtained from eBioServer application and employee role and
verification type is optional
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
POST /[Link] HTTP/1.1
Host: localhost
Content-Type:
Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "[Link]
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
xmlns:soap="[Link]
//[Link]/soap/envelope/">
<soap:Body>
<UpdateEmployee xmlns="[Link]
<UserName>string</UserName>
</UserName>
<Password>string</Password>
</Password>
<EmployeeCode>string
string</EmployeeCode>
<EmployeeName>string
string</EmployeeName>
<EmployeeLocation>
<EmployeeLocation>string</EmployeeLocation>
<EmployeeRole>string
string</EmployeeRole>
<EmployeeVerificationType> </EmployeeVerificationType>
<EmployeeVerificationType>string</EmployeeVerificationType>
</UpdateEmployee>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type:
Type: text/xml; charset=utf-8
CONFIDENTIAL Page 3 of 10
eBioServerNew
Content-Length: length
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
xmlns:soap="[Link]
<soap:Body>
<UpdateEmployeeResponse xmlns="[Link]
<UpdateEmployeeResult>
<UpdateEmployeeResult>string</UpdateEmployeeResult>
</UpdateEmployeeResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 4 of 10
eBioServerNew
Employee Details (Name:
Name: GetEmployeeDetails)
Example:[Link] GetEmployeeDetails
eBioserverNew/[Link]?op=GetEmployeeDetails
By calling this method wee can retrieve employee details like Employee code, Name,
N Card
Number, Location code, Employee Role and Verification Type
Result will be displayed as error or success
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
POST /[Link] HTTP/1.1
Host: localhost
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
SOAPAction: "[Link]
"[Link]
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
xmlns:soap="[Link]
<soap:Body>
<GetEmployeeDetailss xmlns="[Link]
<UserName>string</UserName>
</UserName>
<Password>string</Password>
</Password>
<EmployeeCode>string
string</EmployeeCode>
</GetEmployeeDetails>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
xmlns:soap="[Link]
<soap:Body>
mployeeDetailsResponse xmlns="[Link]
<GetEmployeeDetailsResponse
<GetEmployeeDetailsResult> </GetEmployeeDetailsResult>
<GetEmployeeDetailsResult>string</GetEmployeeDetailsResult>
</GetEmployeeDetailsResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 5 of 10
eBioServerNew
Employee Codes (Name:
Name: GetEmployeeCodes)
Example: [Link] GetEmployeeCodes
eBioserverNew/[Link]?op=GetEmployeeCodes
By calling this method we can retrieve employee codes from the database
Result will be displayed as error or success
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
POST /[Link] HTTP/1.1
Host: localhost
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
SOAPAction: "[Link]
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsi instance"
xmlns:xsd="[Link]
xmlns:soap="[Link]
<soap:Body>
<GetEmployeeDetails xmlns="[Link]
<UserName>string</UserName>
</UserName>
<Password>string</Password>
</Password>
<EmployeeCode>string
string</EmployeeCode>
</GetEmployeeDetails>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
xmlns:soap="[Link]
<soap:Body>
<GetEmployeeDetailsResponse xmlns="[Link]
<GetEmployeeDetails </GetEmployeeDetailsResult>
<GetEmployeeDetailsResult>string</GetEmployeeDetailsResult>
</GetEmployeeDetailsResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 6 of 10
eBioServerNew
Employee Punch Logs (Name:
( GetEmployeePunchLogs)
Example: - [Link] GetEmployeePunchLogs
eBioserverNew/[Link]?op=GetEmployeePunchLogs
By calling this method we can Get Employee Transaction Punch logs of employees like first in
punch and last out punch of single date with semicolon and followed by all the punches with
comma separation of single date
Result will be displayed as error or success
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
POST /[Link] HTTP/1.1
Host: localhost
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
SOAPAction: "[Link]
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
xmlns:soap="[Link]
xmlns:soap="[Link]
<soap:Body>
<GetEmployeePunchLogs xmlns="[Link]
<UserName>string</UserName>
</UserName>
<Password>string</Password>
</Password>
<EmployeeCode>string
string</EmployeeCode>
<AttendanceDate>string
string</AttendanceDate>
</GetEmployeePunchLogs>
GetEmployeePunchLogs>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
="[Link]
xmlns:soap="[Link]
<soap:Body>
<GetEmployeePunchLogsResponse xmlns="[Link]
<GetEmployeePunchLogsResult> </GetEmployeePunchLogsResult>
<GetEmployeePunchLogsResult>string</GetEmployeePunchLogsResult>
</GetEmployeePunchLogsResponse>
PunchLogsResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 7 of 10
eBioServerNew
Delete Employee (Name:
Name: DeleteEmployeeo)
Example:[Link] DeleteEmployee
eBioserverNew/[Link]?op=DeleteEmployee
By calling this method, Employee will be deleted from particular location of all the devices
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
POST /[Link] HTTP/1.1
Host: localhost
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
SOAPAction: "[Link]
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
xmlns:xsd="[Link]
xmlns:soap="[Link]
<soap:Body>
<DeleteEmployee xmlns="[Link]
<UserName>string</UserName>
</UserName>
<Password>string</Password>
</Password>
<EmployeeCode>string
string</EmployeeCode>
</DeleteEmployee>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
="[Link]
xmlns:soap="[Link]
<soap:Body>
<DeleteEmployeeResponse xmlns="[Link]
<DeleteEmployeeResult>
<DeleteEmployeeResult>string</DeleteEmployeeResult>
</DeleteEmployeeResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 8 of 10
eBioServerNew
UpdateEmployeewithExpiryDates (Name:UpdateEmployeewithExpiryDates)
Example: [Link] UpdateEmployeewithExpiryDates
eBioserverNew/[Link]?op=UpdateEmployeewithExpiryDates
By calling this method wee can add employee to particular location or multiple location by
passing value Employee code, Name,
N Card Number, Location code with separated comma,
comma
Employee Role, Verification Type and Expiry date
Result will be displayed as error or success
Note: User name & password can obtained from eBioServer application and employee role and
verification type is optional
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
POST /[Link] HTTP/1.1
Host: localhost
Content-Type:
Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "[Link]
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
xmlns:xsi="[Link] instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsd="[Link]
xmlns:soap="[Link]
lns:soap="[Link]
<soap:Body>
<UpdateEmployeewithExpiryDates xmlns="[Link]
<UserName>string</UserName>
</UserName>
<Password>string</Password>
</Password>
<EmployeeCode>string
string</EmployeeCode>
<EmployeeName>string
string</EmployeeName>
<EmployeeLocation>
<EmployeeLocation>string</EmployeeLocation>
<EmployeeRole>string
string</EmployeeRole>
<EmployeeVerificationType> </EmployeeVerificationType>
<EmployeeVerificationType>string</EmployeeVerificationType>
<EmployeeExpiryFrom>
<EmployeeExpiryFrom>string</EmployeeExpiryFrom>
<EmployeeExpiryTo>
EmployeeExpiryTo>string</EmployeeExpiryTo>
</UpdateEmployeewithExpiryDates>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
<?xml version="1.0" encoding="utf
encoding="utf-8"?>
instance"
<soap:Envelope xmlns:xsi="[Link]
xmlns:xsi="h
xmlns:xsd="[Link]
xmlns:soap="[Link]
CONFIDENTIAL Page 9 of 10
eBioServerNew
<soap:Body>
<UpdateEmployeewithExpiryDatesResponse xmlns="[Link]
<UpdateEmployeewithExpiryDatesResult> </UpdateEmployeewithExpiryDatesRes
piryDatesResult>string</UpdateEmployeewithExpiryDatesRes
ult>
</UpdateEmployeewithExpiryDatesResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 10 of 10
