reluid (Release a user ID)

Releases a user ID and makes it available for future allocation.

You must release the user ID after completing running queries, so that the ID is available to other users. The user ID will stay logged in until its idle time times out, saving other users the time to start a new session.

Releasing a user ID is separate from logging out.

Query string

The query string in the HTTP header must contain the following parameters:

api
Specify the name of the API transaction.
apiversion
Specify the version of the API that should handle the requested transaction.

For the most up-to-date version, use apiversion=3.

uid
Specify a valid 1010data user name.
pswd
The encrypted password for the session. If no active session exists, use the unencrypted password for the UID. See the section titled Additional info for more information.
sid
The session ID for the current API session.

This value is returned by the login transaction and must be provided for most subsequent transactions. Provide this value unless the session has ended or you no longer have access to the session information. See the section titled Additional info for more information.

gid
The group identifier for the SAM pool. The SAM pool is a group containing some number of UID's. A valid gid follows the same rules as a valid uid.

Additional info

When using the reluid transaction, the UID provided must be the 1010data UID that should be released back to the SAM pool for future allocation, and the password provided must be the password for that ID.

As a best practice, you should provide the session ID (sid) and encrypted password (pswd) if the UID being released has an active session. If the UID being released has been logged out, or if you no longer have access to the session credentials, you can release the UID by providing the unencrypted password for that UID. In this case, the session ID (sid) is not required.

XML input to server

No XML input is required. All data for the transaction is specified in the connection string.

XML response from server

A successful result contains the following elements:

<rc>
The return code generated by the transaction. For a list of return codes, see Return codes.
<msg>
The message returned by the system. Specific messages correspond to specific return codes.

Query string example

https://www2.1010data.com/gw.k?api=reluid&apiversion=3&uid=$UID&pswd=$PSWD&sid=$SID

reluid example

Request: 
https://www2.1010data.com/cgi-bin/gw?apiversion=3&api=reluid
   &uid=clientx_0&pswd=*********&sid=1392666444
    
Response:
<out>
<rc>0</rc>
<msg>uid released</msg>
</out>