logout
Parameter | Type | IN | Description |
---|---|---|---|
IN | Parameters described in Overview | ||
Action | String | IN | Identifier for the action requested |
Session [OPTIONAL] | String | IN | The session identifier, becomes mandatory if user and password not supplied |
User [OPTIONAL] | String | IN | The user ID, becomes mandatory if session not supplied |
password [OPTIONAL] | String | IN | The user password, becomes mandatory if session not supplied |
Response | XML / JSON | OUT | An XML tree / JSON string containing the response |
Description
Calling the users API with an action of logout retrieves the success/fail of the logout action.
Return Values
Response – Success/fail response.
The structure of the response is:
<Responses>
<Success>
<SuccessText>Session logged out.</SuccessText>
</Success>
</Responses>
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "Session logged out.",
"success": true
}