This method returns the list of all interest categories, optionally including interests assigned to security categories normally not visible to the caller.
Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
---|---|---|---|
CRConsAPI | SRConsAPI | GET, POST | Server. |
See topic Common Parameters.
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.
Optional. Determines whether to include hidden interests (interests in security categories normally not visible to the caller) in the result set.
Type xsd:boolean.
Default is false.
Optional. The member ID (Client ID) that uniquely identifies the constituent.
Type xsd:string.
Optional. The primary email address that uniquely identifies the constituent.
Type xsd:string.
See topic Common Parameters.
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.
Optional. Determines whether to include hidden interests (interests in security categories normally not visible to the caller) in the result set.
Type xsd:boolean.
Default is false.
Optional. The member ID (Client ID) that uniquely identifies the constituent.
Type xsd:string.
Optional. The primary email address that uniquely identifies the constituent.
Type xsd:string.
See topic HTTP Status Codes.
XML response<?xml version="1.0" encoding="UTF-8"?> <listInterestsResponse 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>1001</id> <label>Interest Name</label> <path>Interest Full Name</path> <for_email>false</for_email> <for_web>true</for_web> <parent>Parent Category</parent> <description>Interest Description</description> <center_id>1000</center_id> <center_label>Center Name</center_label> </interest> </listInterestsResponse>JSON response
{"listInterestsResponse":{"interest":{"id":"1001","center_label":"Center Name","description":"Interest Description","for_web":"true","path":"Interest Full Name","parent":"Parent Category","for_email":"false","label":"Interest Name","center_id":"1000"}}}