User logout (User.Logout)

Description

Logouts the user and destroys the session ID.

Input Parameters

Command=User.Logout [required]

This parameter defines the API command to run. It should be equal to User.Logout.

ResponseFormat [optional] [default=XML]

Defines the response data format. It can be equal to XML or JSON .

SessionID [required]

Your session ID. In order to run this API call, you need to be logged in and have session ID.

Output Parameters

Success [true or false]

If an error has occurred, this parameter will be equal to false. Otherwise it will be set to true.

ErrorCode [integer]

If an error has occurred, this parameter will contain error codes. Otherwise it will be set to 0.

SessionID [string]

If login was successful, this parameter will contain the session ID that you will need on your following API calls.

Error Codes

#9998

Unauthorized access. User login required to execute this API call.

#9999

Invalid API call. Please check the API command and try again.

Example

Request:

curl http://acme.sendloop.com/api/v2/Command=User.Logout&
APIKey=239ce66c239kdb7d52f1216fda4bf3a23id392
&SessionID=759ekrt4efgolvtnqifboi7b00
&ResponseFormat=XML

Response:

<?xml version="1.0" encoding="utf-8"?>
<response>
    <Success><![CDATA[1]]></Success>
    <ErrorCode>
        <subnode_0><![CDATA[0]]></subnode_0>
    </ErrorCode>
    <SessionID><![CDATA[759ekrt4efgolvtnqifboi7b00]]></SessionID>
</response>