getUserCenters

This method returns a list of centers that the specified constituent is a member of.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=getUserCenters &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 ] [ &cons_id=value ] [ &member_id=value ] [ &primary_email=value ] [ &auth=value ] [ &sso_auth_token=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=getUserCenters & 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 ] [ & cons_id =value ] [ & member_id =value ] [ & primary_email =value ]

Usage Notes

If this method is called within a logged-in session context, either from a "remember me" cookie or a user login, this method will return a list of the Centers the constituent belongs to, if any.

If the caller is not within a logged-in session context, this method requires a cons_id, a member_id, or a primary_email parameter that uniquely identifies the constituent, and returns the list of Centers associated with that constituent.

If no constituent or if multiple constituents match the information supplied, or if your Luminate Online site is not configured for Multi-Center support, this method retuns an empty result set.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

cons_id

Optional. The constituent ID (Luminate Online ID) that uniquely identifies the constituent. This value is automatically assigned when a new constituent record is created. It can be used to uniquely identify a constituent record to read or update it. Only available when called using an administrator account.

Type xsd:string.

member_id

Optional. The member ID (Client ID) that uniquely identifies the constituent.

Type xsd:string.

primary_email

Optional. The primary email address that uniquely identifies the constituent.

Type xsd:string.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

cons_id

Optional. The constituent ID (Luminate Online ID) that uniquely identifies the constituent. This value is automatically assigned when a new constituent record is created. It can be used to uniquely identify a constituent record to read or update it. Only available when called using an administrator account.

Type xsd:string.

member_id

Optional. The member ID (Client ID) that uniquely identifies the constituent.

Type xsd:string.

primary_email

Optional. The primary email address that uniquely identifies the constituent.

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<getConsCentersResponse 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">
  <centerMembership>
    <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>
    <email_opt_in>true</email_opt_in>
  </centerMembership>
</getConsCentersResponse>

        
JSON response
{"getConsCentersResponse":{"centerMembership":{"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"},"email_opt_in":"true"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: