Luminate Online

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRConsAPI	None.	GET, POST	No.

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=logout &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ]

Usage Notes

The logout method closes a user's logged-in session with the Luminate Online hosted site.

Client API Parameters

Common Client Parameters: See topic Common Parameters.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<loginResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <message>User logged out successfully.</message>
</loginResponse>

JSON response

{"loginResponse":{"message":"User logged out successfully."}}

Examples

When a user wants to log out of the partner system, they expect to be logged out of the Luminate Online system at the same time.

The solution in this scenario is to design a secure form that uses POST to this URL: https://securex.convio.net/[org]/site/CRConsAPI

The form should look something like this:


<form method="post" action="https://securex.convio.net/yoursite/site/CRConsAPI">
  <input type="hidden" name="api_key" id="api_key" value="open" />
  <input type="hidden" name="v" id="v" value="1.0" />
  <input type="hidden" name="method" id="method" value="logout" />
  <input type="hidden" name="success_redirect" value="http://yourothersite.org/logout.html" >
  <input type="hidden" name="error_redirect" value="http://yourothersite.org/logout.html?code=&message=" >
  <input type="hidden" name="sign_redirects" id="sign_redirects" value="true" />
  <input type="submit" value="Logout" name="Submit" />
</form>

Upon the user's return, partner system should process its logout and then redirect the user to an appropriate page.