Index | Method | Request(s) | Response | Description | ||||
---|---|---|---|---|---|---|---|---|
1 | login |
username password |
starts a new session; returns the session identifier(SID) | |||||
2 | renew |
sid |
renews an existing session | |||||
3 | logout |
sid |
closes a session | |||||
4 | valid |
sid |
checks if a SID is valid; returns true only if the session is valid |
starts a new session; returns the session identifier(SID)
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
username
|
String | Y | ||||||
password
|
String | Y |
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
|
String | Y |
renews an existing session
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
sid
|
String | Y | the session identifier |
closes a session
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
sid
|
String | Y | the session identifier |
checks if a SID is valid; returns true only if the session is valid
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
sid
|
String | Y | the session identifier |
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
|
Boolean | Y |