Remote login to a publication
Grants a session ID based on a username and password combination. When the collection and book parameters are provided, this session ID is valid to use as the id parameter for other API calls that require a book and collection parameter.
Example API call
/servlets3/wietmsd?date=135132123123&target=interface&action=get_session_id&username=guest&password=guest&collection=default&book=PDMUNITTEST
Parameters
| Parameter | Description |
|---|---|
target | interface |
action | get_session_id |
username | The username of the user who is logging in. |
password | The password that matches the username. |
collection | The name of the collection that the publication is registered in, such as default. |
book | The name of the publication, such as PDMUNITTEST. |
date | To prevent browser-side caching of data, especially with AJAX requests, it is important to make a URL unique. The most effective technique to accomplish this is to include a time parameter that is based on the time at which the call is made. |
Returns
- On success
-
<?xml version="1.0"?> <results> <status> SUCCESS</status> <message> Success!!!</message> <empty_passwd/> <temp_passwd/> <request name="get_session_id"> <collection>default</collection> <book>PDMUNITTEST</book> </request> <reply> <session-id>1508952568324</session-id> </reply> </results> - On failure
-
<results> <status> ERROR</status> <message> Invalid username or password</message> <request name="get_session_id" > <collection>default</collection> <book>PDMUNITTEST</book> </request> <reply> <session-id/> </reply> </results>