CSL RFID Programmer’s Manual
CS461 High-Level API Table v1.5.21
1. HTTP Protocol Support
1.1. HTTP Protocol Table
The following is a table of the HTTP query strings and the XML based response document
layout. It consists of 9 main categories:
1. Users Management
2. System Management
3. Network Management
4. Time and Timer Management
5. Version Management
6. Capture Point Management
7. Tag and Tag Filter Management
8. IO Management
9. Events Management
© Convergence Systems Limited. All Rights Reserved.
Information in this document is subject to change without prior notice.
1
CSL RFID Programmer’s Manual
1.2. HTTP API Format
(1) Server Æ Reader
The format of High-level HTTP API query from server to reader is as follows:
http://<IP_address_of_Reader>/API?session_id=<session_id>&comma
nd=<command>[&<param1>=<param1_value>]
where:
Variable Description
<IP_address_of_Reader> IP address of the CS461 reader
<session_id> The session ID obtained in the XML response message from reader after user
login (not necessary for some commands, e.g. login)
<command> High-level API command
<param1> Setting parameter for the corresponding command. It can be optional or more
than one parameter
<param1_value> Value for the corresponding parameter setting
(2) Reader Æ Server
The format of XML/HTTP response from reader to server is as follows:
<?xml version="1.0" ?>
<CSL>
<Command>command1</Command>
<Ack>ack_value</Ack>
<Param1="param1_value" Param2="param2_value" />
</CSL>
Note:
- This document is applicable to CS461 firmware version 2.2.0 or above
- All High-Level HTTP API query strings are Case-Sensitive.
© Convergence Systems Limited. All Rights Reserved.
Information in this document is subject to change without prior notice.
2
CSL RFID Programmer’s Manual
query_string Description
Users Management
1 session_id=<login_session_id>&
command=addUser&
username=username&
password=password&
level=level[&
desc=desc]
Adds a new user with name username, password password,
administrative privileges level level.
e.g.
session_id=<login_session_id>&command=addUser&username
=Bruce Li&password=pw123&level=1
result:
<?xml version="1.0" ?>
-
<CSL>
<Command>addUser</Command>
<Ack>OK:</Ack>
</CSL>
2 session_id=<login_session_id>&
command=delUser&
username=username
Removes the user with name username.
e.g.
session_id=<login_session_id>&command=delUser&username=
Bruce Li
result:
<?xml version="1.0" ?>
-
<CSL>
<Command>delUser</Command>
<Ack>OK:</Ack>
</CSL>
3 session_id=<login_session_id>&
command=setUserPassword&
username=username&
password=password
Sets the user password for the user with name username.
Only “root” user can invoke this command.
e.g.
session_id=<login_session_id>&command=setUserPassword&u
sername=Bruce Li&password=mod123
© Convergence Systems Limited. All Rights Reserved.
Information in this document is subject to change without prior notice.
3
CSL RFID Programmer’s Manual
result:
<?xml version="1.0" ?>
-
<CSL>
<Command>setUserPassword</Comman
d>
<Ack>OK:</Ack>
</CSL>
4 session_id=<login_session_id>&
command=listUsers
List all users information.
e.g.
session_id=<login_session_id>&command=listUsers
result:
<?xml version="1.0" ?>
-
<CSL>
<Command>listUsers</Command>
<Account desc="top level administrator"
level="9" username="root" />
<Account desc="test purpose" level="1"
username="test engineer" />
<Account desc="" level="1"
username="Bruce Li" />
</CSL>
5 command=login&
username=username&
password=password
Login is required for access to the reader.
Login is successful if password for the user is correct.
e.g.
command=login&username=root&password=csl2006
result 1:
(Login successfully)
<?xml version="1.0" ?>
<CSL>
<Command>login</Command>
<Ack>OK: session_id=768f32f8</Ack>
</CSL>
result 2:
(If other user has already logged-in)
<?xml version="1.0" ?>
© Convergence Systems Limited. All Rights Reserved.
Information in this document is subject to change without prior notice.
4
CSL RFID Programmer’s Manual
- <CSL>
<Command>login</Command>
<Error alreadyLoginIP="192.168.25.124"
alreadyLoginUser="root" code="-10"
msg="Error: Only one user can login
the system at the same time!Another
User root has already logged-in the
system (by browser or API
command) at location
192.168.25.124.Please logout the
other user and retry login." />
</CSL>
6 session_id=<login_session_id>&
command=logout
Log out is recommended to ensure the security and integrity of
the system.
e.g.
session_id=<login_session_id>&command=logout
result:
<?xml version="1.0" ?>
-
<CSL>
<Command>logout</Command>
<Ack>OK:</Ack>
</CSL>
7 command=forceLogout&
username=username&
password=password
Force logout the system and intend to login another session for
operation.
e.g.
command=forceLogout&username=root&password=<password
>
Remark : username must be “root”
result:
<?xml version="1.0" ?>
-
<CSL>
<Command>forceLogout</Command>
<Ack>OK:</Ack>
</CSL>
8 session_id=<login_session_id>& Set the auto logout time to the Edge Server such that the it will
© Convergence Systems Limited. All Rights Reserved.
Information in this document is subject to change without prior notice.
5
- 1
- 2
前往页