getInteraction

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.

Client API Syntax

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

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=getInteraction & 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 ] & interaction_id =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.

interaction_id

Required. The id of the interaction.

Type xsd:nonNegativeInteger.

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.

interaction_id

Required. The id of the interaction.

Type xsd:nonNegativeInteger.

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"?>
<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

Submitted by BrianPMucha at 02:15 PM on September 14, 2015
This actually returns getUserInteractionsResponse and not getInteractionResponse.

Leave a Comment

Nickname
Comment
Enter this word: