Luminate Online

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRAddressBookAPI	None.	GET, POST	Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRAddressBookAPI?method=getAddressBookContacts &api_key=value &v=value [ &auth=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_ascending=value ] [ &list_category_id=value ] [ &list_filter_column=value ] [ &list_filter_text=value ] [ &list_page_offset=value ] [ &list_page_size=value ] [ &list_record_offset=value ] [ &list_sort_column=value ] [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

list_ascending

Optional. Whether the list should be sorted in ascending order.

Type xsd:boolean.

Default is true.

list_category_id

Optional. Security Category filter.

Type xsd:integer.

list_filter_column

Optional. The database column that will be used to match the filter text (used with "list_filter_text").

Type xsd:string.

list_filter_text

Optional. The text that will be used to filter results.

Type xsd:string.

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.

list_sort_column

Optional. The column to sort with (used with "list_ascending").

Type xsd:string.

auth

Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.

sso_auth_token

Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getAddressBookContactsResponse 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">
  <addressBookContact>
    <id>101</id>
    <firstName>User1First</firstName>
    <lastName>User1Last</lastName>
    <email>user1@example.com</email>
    <group>
      <id>201</id>
      <name>Group 1</name>
    </group>
  </addressBookContact>
  <addressBookContact>
    <id>102</id>
    <firstName>User2First</firstName>
    <lastName>User2Last</lastName>
    <email>user2@example.com</email>
    <group>
      <id>202</id>
      <name>Group 2</name>
    </group>
    <group>
      <id>202</id>
      <name>Group 2</name>
    </group>
  </addressBookContact>
</getAddressBookContactsResponse>

JSON response

{"getAddressBookContactsResponse":{"addressBookContact":[{"id":"101","lastName":"User1Last","email":"user1@example.com","group":{"id":"201","name":"Group 1"},"firstName":"User1First"},{"id":"102","lastName":"User2Last","email":"user2@example.com","group":[{"id":"202","name":"Group 2"},{"id":"202","name":"Group 2"}],"firstName":"User2First"}]}}

getAddressBookContacts

Client API Syntax

Client API Parameters

Response

Leave a Comment