eBioServerNew-Web_API-Manual
eBioServerNew-Web_API-Manual
About This Manual: This document introduces the eBioServerNew Web API services
for the user interface and operations of the eBioServerNew
CONFIDENTIAL Page 1 of 34
eBioServerNew
CONFIDENTIAL Page 2 of 34
eBioServerNew
CONFIDENTIAL Page 3 of 34
eBioServerNew
(Example:
le: http://eBioserverNew/Webservice.asmx)
http://eBioserverNew
Methods:
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
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
CONFIDENTIAL Page 4 of 34
eBioServerNew
Content-Length: length
CONFIDENTIAL Page 5 of 34
eBioServerNew
Example:http://eBioserverNew/W GetEmployeeDetails
eBioserverNew/Webservice.asmx?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
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
CONFIDENTIAL Page 6 of 34
eBioServerNew
By calling this method we can retrieve employee codes from the database
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
CONFIDENTIAL Page 7 of 34
eBioServerNew
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
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
CONFIDENTIAL Page 8 of 34
eBioServerNew
Example:http://eBioserverNew/W DeleteEmployee
eBioserverNew/Webservice.asmx?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
CONFIDENTIAL Page 9 of 34
eBioServerNew
UpdateEmployeewithExpiryDates (Name: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
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
CONFIDENTIAL Page 10 of 34
eBioServerNew
<soap:Body>
<UpdateEmployeewithExpiryDatesResponse xmlns="http://tempuri.org/">
<UpdateEmployeewithExpiryDatesResult> </UpdateEmployeewithExpiryDatesRes
piryDatesResult>string</UpdateEmployeewithExpiryDatesRes
ult>
</UpdateEmployeewithExpiryDatesResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 11 of 34
eBioServerNew
By calling this method wee can add or update employee photo for registered employee by passing
value Employee code, Employee Photo, 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
CONFIDENTIAL Page 12 of 34
eBioServerNew
By calling this method wee can add or update employee with photo for registered employee by
passing value Employee code, Name, Location, Role, Verification, Expiry Dates, Card Number
and Employee Photo 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
CONFIDENTIAL Page 13 of 34
eBioServerNew
xmlns:xsi="http://www.w3.org/2001/XMLSchema instance"
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
w.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<UpdateEmployeeExResponse xmlns="http://tempuri.org/">
<UpdateEmployeeExResult> </UpdateEmployeeExResult>
<UpdateEmployeeExResult>string</UpdateEmployeeExResult>
</UpdateEmployeeExResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 14 of 34
eBioServerNew
Note: User name & password can obtained from eBioServer application and employee role and
verification type is optional
CONFIDENTIAL Page 15 of 34
eBioServerNew
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
CONFIDENTIAL Page 16 of 34
eBioServerNew
By calling this method we can get device Illegal Punch records of all location or particular
location with Log date time stamp, Employee code, Device Name, Device location name nam
followed by with comma separation of single record and next record with semicolon.
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
CONFIDENTIAL Page 17 of 34
eBioServerNew
By calling this method wee can add or update location by passing value location code, Description
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
CONFIDENTIAL Page 18 of 34
eBioServerNew
By calling this method wee can delete location by passing value location code
Note:
Location will be deleted only if this not associated with employee or devices
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
<?xml
?xml version="1.0" encoding="utf-8"?>
encoding="utf
xmlns:xsi="http://www.w3.org/2001/XMLSchema instance"
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<DeleteLocationResponse xmlns="http://tempuri.org/">
xmlns=
<DeleteLocationResult>
<DeleteLocationResult>string</DeleteLocationResult>
</DeleteLocationResponse>
</soap:Body>
CONFIDENTIAL Page 19 of 34
eBioServerNew
</soap:Envelope>
CONFIDENTIAL Page 20 of 34
eBioServerNew
By calling this method wee can add or update devices by passing value Device Serial Number,
Device Name, Device Direction, Device Type, Time Zone, Device Activation code, Location, Is
Attendance Device.
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
CONFIDENTIAL Page 21 of 34
eBioServerNew
<soap:Body>
<UpdateDeviceResponse xmlns="http://tempuri.org/">
<UpdateDeviceResult>
<UpdateDeviceResult>string</UpdateDeviceResult>
</UpdateDeviceResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 22 of 34
eBioServerNew
By calling this method wee can delete devices by passing value Device Serial Number
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
CONFIDENTIAL Page 23 of 34
eBioServerNew
By calling this method wee can get device last ping by passing value Device Serial Number
Note:
User name & password can obtained from eBioServer application and employee role and
verification type is optional
The following is a samplee SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values
<?xml
?xml version="1.0" encoding="utf-8"?>
encoding="utf
xmlns:xsi="http://www.w3.org/2001/XMLSchema instance"
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetDeviceLastPing xmlns="http://tempuri.org/">
xmlns="http
<UserName>string</UserName>
</UserName>
<Password>string</Password>
</Password>
<DeviceSerialNumber>
<DeviceSerialNumber>string</DeviceSerialNumber>
</GetDeviceLastPing>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
CONFIDENTIAL Page 24 of 34
eBioServerNew
By calling this method wee can reboot device remotely by passing value Device Serial Number
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
CONFIDENTIAL Page 25 of 34
eBioServerNew
By calling this method wee can get all enrolled employees details to the server from the devices
by passing value Device Serial Number
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
<DeviceCommand_ResetOPStampResult>string</DeviceCommand_ResetOPStampResult>
<DeviceCommand_ResetOPStampResult> </DeviceCommand_ResetOPStampResult>
</DeviceCommand_ResetOPStampResponse>
eviceCommand_ResetOPStampResponse>
</soap:Body>
CONFIDENTIAL Page 26 of 34
eBioServerNew
</soap:Envelope>
CONFIDENTIAL Page 27 of 34
eBioServerNew
(Name: DeviceCommand_ResetTransactionStamp
DeviceCommand_Reset )
Example:
http://eBioserverNew/Webservice.asmx?op=DeviceCommand_ResetTransactionStamp
http://eBioserverNew/Webservice.asmx?op=DeviceCommand_ResetTransaction
By calling this method wee can get entire punch records of employee’s from the beginning till
current date to the server from the devices by passing value Device Serial Number
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
CONFIDENTIAL Page 28 of 34
eBioServerNew
<DeviceCommand_ResetTransactionStampResult> </DeviceCommand_ResetTransac
ceCommand_ResetTransactionStampResult>string</DeviceCommand_ResetTransac
tionStampResult>
</DeviceCommand_ResetTransactionStampResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 29 of 34
eBioServerNew
By calling this method wee can clear all log records of employee remotely from the devices by
passing value Device Serial Number
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
CONFIDENTIAL Page 30 of 34
eBioServerNew
(Name:DeviceCommand_ChangeWebServerAddress)
Example:
http://eBioserverNew/Webservice.asmx?op=DeviceCommand_ChangeWebServerAddress
http://eBioserverNew/Webservice.asmx?op= DeviceCommand_ChangeWebServerAddress
By calling this method wee can change Web url or IP address remotely in the devices by passing
value Device Serial Number and Web Server Address
Note:
User name & password can an 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
CONFIDENTIAL Page 31 of 34
eBioServerNew
<soap:Body>
<DeviceCommand_ChangeWebServerAddressResponse
<DeviceCommand_ChangeWebServerAddr
xmlns="http://tempuri.org/">
<DeviceCommand_ChangeWebServerAddressResult>string</DeviceCommand_ChangeWebSe
<DeviceCommand_ChangeWebServerAddressResult> </DeviceCommand_ChangeWebSe
rverAddressResult>
</DeviceCommand_ChangeWebServerAddressResponse>
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 32 of 34
eBioServerNew
(Name:DeviceCommand_ChangeWebPortNumber
DeviceCommand_ChangeWeb )
Example:
http://eBioserverNew/Webservice.asmx?op=DeviceCommand_ChangeWeb
http://eBioserverNew/Webservice.asmx?op= DeviceCommand_ChangeWebPortNumber
By calling this method wee can change web server port number remotely in the devices by
passing value Device Serial Number and Web Server port number
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
<?xml version="1.0"
rsion="1.0" encoding="utf-8"?>
encoding="utf
xmlns:xsi="http://www.w3.org/2001/XMLSchema instance"
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
xmlns="http://tempuri.org/">
<DeviceCommand_ChangeWebServerPort xmlns="http://tempuri.org/">
<UserName>string</UserName>
</UserName>
<Password>string</Password>
</Password>
<DeviceSerialNumber>
<DeviceSerialNumber>string</DeviceSerialNumber>
<WebServerPort>string
string</WebServerPort>
</DeviceCommand_ChangeWebServerPort>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type:
Type: text/xml; charset=utf-8
charset=utf
Content-Length: length
CONFIDENTIAL Page 33 of 34
eBioServerNew
<soap:Body>
<DeviceCommand_ChangeWebServerPortResponse xmlns="http://tempuri.org/">
<DeviceCommand_ChangeWebServerPortResult>string</DeviceCommand_ChangeWebServe
<DeviceCommand_ChangeWebServerPortResult> </DeviceCommand_ChangeWebServe
rPortResult>
</DeviceCommand_ChangeWebServerPortResponse>
</DeviceCommand_Chan
</soap:Body>
</soap:Envelope>
CONFIDENTIAL Page 34 of 34