logInteraction

This method can be used to manually log an interaction record for the specified constituent containing information supplied by the caller. 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). A custom interaction type ID may be specified. If it is not then then the interaction logged is of type "Other".The body of the comment has a maximum size of 1500 characters.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=logInteraction &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_subject=value [ &cons_id=value ] [ &interaction_body=value ] [ &interaction_cat_id=value ] [ &interaction_count=value ] [ &interaction_type_id=value ] [ &member_id=value ] [ &primary_email=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=logInteraction & 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_subject =value [ & cons_id =value ] [ & interaction_body =value ] [ & interaction_cat_id =value ] [ & interaction_count =value ] [ & interaction_type_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. An interaction is recorded for the logged in user.

This method is automatically invoked by any call to the create, or by any call to update or createOrUpdate that specifies one of the unique identifier parameters listed above.

By default, the logInteraction method creates an interaction record for the constituent of type 0='Other,' using the values (if any) supplied in the interaction_cat_id, interaction_subject, interaction_body, and interaction_count parameters, or their defaults. If the interaction_type_id is specified with a valid, custom interaction type ID an interaction of that type will be created. The method also logs the caller's IP address and the user account ID for the caller's login session (may be either the constituent's ID or the ID of an administrator account used by the caller.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

interaction_subject

Required. Short, descriptive subject of the user interaction. Can be up to 80 characters in length.

Type xsd:string.

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.

interaction_body

Optional. Text describing or associated with the interaction.

Type xsd:string.

interaction_cat_id

Optional. The Security Category associated with this interaction. The default is 0, which corresponds to the "General" category.

Type xsd:nonNegativeInteger.

Default is 0.

interaction_count

Optional. The number of times the constituent performed this interaction.

Type xsd:nonNegativeInteger.

Default is 1.

interaction_type_id

Optional. The Interaction Type associated with this interaction. If an Interaction Type is specified it must be a custom interaction.The default is 0, which corresponds to the "Other" Interaction Type.

Type xsd:nonNegativeInteger.

Default is 0.

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_subject

Required. Short, descriptive subject of the user interaction. Can be up to 80 characters in length.

Type xsd:string.

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.

interaction_body

Optional. Text describing or associated with the interaction.

Type xsd:string.

interaction_cat_id

Optional. The Security Category associated with this interaction. The default is 0, which corresponds to the "General" category.

Type xsd:nonNegativeInteger.

Default is 0.

interaction_count

Optional. The number of times the constituent performed this interaction.

Type xsd:nonNegativeInteger.

Default is 1.

interaction_type_id

Optional. The Interaction Type associated with this interaction. If an Interaction Type is specified it must be a custom interaction.The default is 0, which corresponds to the "Other" Interaction Type.

Type xsd:nonNegativeInteger.

Default is 0.

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"?>
<updateConsResponse 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">
  <cons_id>1000121</cons_id>
  <message>Interaction logged successfully.</message>
  <interaction_id>1001</interaction_id>
</updateConsResponse>

        
JSON response
{"updateConsResponse":{"message":"Interaction logged successfully.","cons_id":"1000121","interaction_id":"1001"}}

        

Leave a Comment

Nickname
Comment
Enter this word: