This method can be used to get an interaction 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).
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRConsAPI | SRConsAPI | POST | Server. |
See topic Common Parameters.
Required. The id of the interaction.
Type xsd:nonNegativeInteger.
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 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.
Required. The id of the interaction.
Type xsd:nonNegativeInteger.
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 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"?>
<getInteractionResponse 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>1</interactionTypeId>
<categoryId>0</categoryId>
<referenceId>0</referenceId>
<consId>1001001</consId>
<createdBy>1001001</createdBy>
<creationDate>2016-02-01T09:43:35.159-06:00</creationDate>
<note>
<categoryId>0</categoryId>
<typeOfConsNote>normal</typeOfConsNote>
<consId>1001001</consId>
<createdBy>1001001</createdBy>
<creationDate>2016-02-01T09:43:35.159-06:00</creationDate>
<interactionId>1000</interactionId>
<modifiedBy>1001001</modifiedBy>
<modifiedDate>2016-02-01T09:43:35.159-06:00</modifiedDate>
<noteId>1000</noteId>
<subject>Sample Subject</subject>
<text>Lorem ipsum dolor sit amet, consetetur sadipscing</text>
<type>comment</type>
</note>
<subject>Sample Subject</subject>
<count>1</count>
</interaction>
</getInteractionResponse>
JSON response
{"getInteractionResponse":{"interaction":{"creationDate":"2016-02-01T09:43:35.159-06:00","interactionTypeId":"1","count":"1","createdBy":"1001001","consId":"1001001","interactionId":"1000","subject":"Sample Subject","categoryId":"0","referenceId":"0","note":{"creationDate":"2016-02-01T09:43:35.159-06:00","text":"Lorem ipsum dolor sit amet, consetetur sadipscing","interactionId":"1000","createdBy":"1001001","consId":"1001001","typeOfConsNote":"normal","subject":"Sample Subject","modifiedBy":"1001001","categoryId":"0","noteId":"1000","type":"comment","modifiedDate":"2016-02-01T09:43:35.159-06:00"}}}}
Comments