Luminate Online

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

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=listCenters &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 ] [ &list_page_offset=value ] [ &list_page_size=value ] [ &list_record_offset=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=listCenters & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] [ & list_page_offset =value ] [ & list_page_size =value ] [ & list_record_offset =value ]

Usage Notes

If the Luminate Online site is configured for Multi-Center mode, this method returns the list of Centers that the caller can access. Note that this may not include all centers defined for a particular Luminate Online site, and may differ from one caller to another depending upon the caller's role and permissions.

The method supports paging of results.

If your Luminate Online site is not configured for Multi-Center, this method returns an empty list.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

list_page_offset

Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.

Type xsd:integer.

list_page_size

Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").

Type xsd:integer.

Default is 25.

list_record_offset

Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.

Type xsd:integer.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

list_page_offset

Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.

Type xsd:integer.

list_page_size

Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").

Type xsd:integer.

Default is 25.

list_record_offset

Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.

Type xsd:integer.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<listCentersResponse 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">
  <center>
    <id>1</id>
    <label>Center Name</label>
    <description>Center Description</description>
    <home_page>http://www.your_org.org/site/PageServer?pagename=center_home</home_page>
    <not_found_page>http://www.your_org.org/site/PageServer?pagename=center_not_found</not_found_page>
  </center>
</listCentersResponse>

JSON response

{"listCentersResponse":{"center":{"id":"1","description":"Center Description","label":"Center Name","home_page":"http://www.your_org.org/site/PageServer?pagename=center_home","not_found_page":"http://www.your_org.org/site/PageServer?pagename=center_not_found"}}}

listCenters

Client API Syntax

Server API Syntax

Usage Notes

Client API Parameters

Server API Parameters

Response

Leave a Comment