This method can be used to get interactions for a constituent. It must be called by a logged-in user within an authenticated session. This method requires at least one unique identifier for the user (may be cons_id, member_id, or primary_email). Only notes for custom interactions are returned. Notes for standard interactions can be retrieved using the getInteraction API method.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRConsAPI | SRConsAPI | POST | Server. |
See topic Common Parameters.
Optional. The beginning of the date range of the interactions to return, formatted per the ISO 8601 specification.
Type xsd:dateTime.
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. The ending of the date range of the interactions to return, formatted per the ISO 8601 specification.
Type xsd:dateTime.
Optional. Short, descriptive subject of the user interaction. Can be up to 80 characters in length.
Type xsd:string.
Optional. The Interaction Type associated with this interaction.
Type xsd:nonNegativeInteger.
Optional. Whether the list should be sorted in ascending order.
Type xsd:boolean.
Default is true.
Optional. Security Category filter.
Type xsd:integer.
Optional. The database column that will be used to match the filter text (used with "list_filter_text").
Type xsd:string.
Optional. The text that will be used to filter results.
Type xsd:string.
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.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
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.
Optional. The column to sort with (used with "list_ascending").
Type xsd:string.
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 beginning of the date range of the interactions to return, formatted per the ISO 8601 specification.
Type xsd:dateTime.
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. The ending of the date range of the interactions to return, formatted per the ISO 8601 specification.
Type xsd:dateTime.
Optional. Short, descriptive subject of the user interaction. Can be up to 80 characters in length.
Type xsd:string.
Optional. The Interaction Type associated with this interaction.
Type xsd:nonNegativeInteger.
Optional. Whether the list should be sorted in ascending order.
Type xsd:boolean.
Default is true.
Optional. Security Category filter.
Type xsd:integer.
Optional. The database column that will be used to match the filter text (used with "list_filter_text").
Type xsd:string.
Optional. The text that will be used to filter results.
Type xsd:string.
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.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
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.
Optional. The column to sort with (used with "list_ascending").
Type xsd:string.
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"?>
<getUserInteractionsResponse 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">
<interaction>
<interactionId>1000</interactionId>
<interactionTypeId>1000</interactionTypeId>
<categoryId>1000</categoryId>
<referenceId>0</referenceId>
<consId>1001001</consId>
<createdBy>1001001</createdBy>
<creationDate>2016-02-01T09:43:35.283-06:00</creationDate>
<subject>Sample Subject 0</subject>
<count>1</count>
<note>
<categoryId>1000</categoryId>
<typeOfConsNote>normal</typeOfConsNote>
<consId>1001001</consId>
<createdBy>1001001</createdBy>
<creationDate>2016-02-01T09:43:35.283-06:00</creationDate>
<interactionId>1000</interactionId>
<modifiedBy>1001001</modifiedBy>
<modifiedDate>2016-02-01T09:43:35.283-06:00</modifiedDate>
<noteId>1000</noteId>
<subject>Sample Subject 0</subject>
<text>Lorem ipsum dolor sit amet, consetetur sadipscing 0</text>
<type>comment</type>
</note>
</interaction>
<interaction>
<interactionId>1001</interactionId>
<interactionTypeId>1001</interactionTypeId>
<categoryId>1001</categoryId>
<referenceId>0</referenceId>
<consId>1001002</consId>
<createdBy>1001002</createdBy>
<creationDate>2016-02-01T09:43:35.283-06:00</creationDate>
<subject>Sample Subject 1</subject>
<count>2</count>
<note>
<categoryId>1001</categoryId>
<typeOfConsNote>normal</typeOfConsNote>
<consId>1001002</consId>
<createdBy>1001002</createdBy>
<creationDate>2016-02-01T09:43:35.283-06:00</creationDate>
<interactionId>1001</interactionId>
<modifiedBy>1001002</modifiedBy>
<modifiedDate>2016-02-01T09:43:35.283-06:00</modifiedDate>
<noteId>1001</noteId>
<subject>Sample Subject 1</subject>
<text>Lorem ipsum dolor sit amet, consetetur sadipscing 1</text>
<type>comment</type>
</note>
</interaction>
<interaction>
<interactionId>1002</interactionId>
<interactionTypeId>6</interactionTypeId>
<categoryId>1002</categoryId>
<referenceId>0</referenceId>
<consId>1001003</consId>
<createdBy>1001003</createdBy>
<creationDate>2016-02-01T09:43:35.283-06:00</creationDate>
<subject>Sample Subject 2</subject>
<count>3</count>
</interaction>
</getUserInteractionsResponse>
JSON response
{"getUserInteractionsResponse":{"interaction":[{"creationDate":"2016-02-01T09:43:35.283-06:00","interactionTypeId":"1000","count":"1","createdBy":"1001001","consId":"1001001","interactionId":"1000","subject":"Sample Subject 0","categoryId":"1000","referenceId":"0","note":{"creationDate":"2016-02-01T09:43:35.283-06:00","text":"Lorem ipsum dolor sit amet, consetetur sadipscing 0","interactionId":"1000","createdBy":"1001001","consId":"1001001","typeOfConsNote":"normal","subject":"Sample Subject 0","modifiedBy":"1001001","categoryId":"1000","noteId":"1000","type":"comment","modifiedDate":"2016-02-01T09:43:35.283-06:00"}},{"creationDate":"2016-02-01T09:43:35.283-06:00","interactionTypeId":"1001","count":"2","createdBy":"1001002","consId":"1001002","interactionId":"1001","subject":"Sample Subject 1","categoryId":"1001","referenceId":"0","note":{"creationDate":"2016-02-01T09:43:35.283-06:00","text":"Lorem ipsum dolor sit amet, consetetur sadipscing 1","interactionId":"1001","createdBy":"1001002","consId":"1001002","typeOfConsNote":"normal","subject":"Sample Subject 1","modifiedBy":"1001002","categoryId":"1001","noteId":"1001","type":"comment","modifiedDate":"2016-02-01T09:43:35.283-06:00"}},{"creationDate":"2016-02-01T09:43:35.283-06:00","interactionTypeId":"6","count":"3","createdBy":"1001003","consId":"1001003","interactionId":"1002","subject":"Sample Subject 2","categoryId":"1002","referenceId":"0"}]}}