getUserInterests

This method returns a list of interest categories associated with the specified constituent.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=getUserInterests &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=getUserInterests & 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 called as a Client API, this method requires authentication. If the requester is an administrator (normally only the case using the Server API):
  1. One of cons_id, member_id, or primary_email must be specified in order to locate the record.
  2. The order of precedence of the search terms is (a) cons_id (b) member_id, then (c) primary_email. If a record is not found or if multiple records are returned by any specified search term evaluated in this order, the method returns an error.
If the requester is a constituent using the Client API:
  1. An authentication token representing the logged-in user must be passed.
  2. Only the constituent record of the logged in user may be retrieved.

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"?>
<getConsInterestsResponse 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">
  <interest>
    <id>1</id>
    <label>Interest Name</label>
    <path>Interest Full Name</path>
    <for_email>false</for_email>
    <for_web>true</for_web>
    <description>Interest Description</description>
  </interest>
</getConsInterestsResponse>
JSON response 
{"getConsInterestsResponse":{"interest":{"id":"1","description":"Interest Description","for_web":"true","path":"Interest Full Name","for_email":"false","label":"Interest Name"}}}
Parent topic: Constituent API
Previous topic: getUserInteractions
Next topic: getUserTransactions

Leave a Comment

Nickname
Comment
Enter this word:
Change