Luminate Online

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

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=listInteractions &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_type_id=value [ &begin_date=value ] [ &end_date=value ] [ &interaction_subject=value ] [ &list_ascending=value ] [ &list_category_id=value ] [ &list_filter_column=value ] [ &list_filter_text=value ] [ &list_page_offset=value ] [ &list_page_size=value ] [ &list_record_offset=value ] [ &list_sort_column=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=listInteractions & 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_type_id =value [ & begin_date =value ] [ & end_date =value ] [ & interaction_subject =value ] [ & list_ascending =value ] [ & list_category_id =value ] [ & list_filter_column =value ] [ & list_filter_text =value ] [ & list_page_offset =value ] [ & list_page_size =value ] [ & list_record_offset =value ] [ & list_sort_column =value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

interaction_type_id

Required. The Interaction Type to find. The type must be a public custom interactions.

Type xsd:nonNegativeInteger.

begin_date

Optional. The beginning of the date range of the interactions to return, formatted per the ISO 8601 specification.

Type xsd:dateTime.

end_date

Optional. The ending of the date range of the interactions to return, formatted per the ISO 8601 specification.

Type xsd:dateTime.

interaction_subject

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

Type xsd:string.

list_ascending

Optional. Whether the list should be sorted in ascending order.

Type xsd:boolean.

Default is true.

list_category_id

Optional. Security Category filter.

Type xsd:integer.

list_filter_column

Optional. The database column that will be used to match the filter text (used with "list_filter_text").

Type xsd:string.

list_filter_text

Optional. The text that will be used to filter results.

Type xsd:string.

list_page_offset

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.

list_page_size

Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").

Type xsd:integer.

Default is 25.

list_record_offset

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.

list_sort_column

Optional. The column to sort with (used with "list_ascending").

Type xsd:string.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

interaction_type_id

Required. The Interaction Type to find. The type must be a public custom interactions.

Type xsd:nonNegativeInteger.

begin_date

Optional. The beginning of the date range of the interactions to return, formatted per the ISO 8601 specification.

Type xsd:dateTime.

end_date

Optional. The ending of the date range of the interactions to return, formatted per the ISO 8601 specification.

Type xsd:dateTime.

interaction_subject

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

Type xsd:string.

list_ascending

Optional. Whether the list should be sorted in ascending order.

Type xsd:boolean.

Default is true.

list_category_id

Optional. Security Category filter.

Type xsd:integer.

list_filter_column

Optional. The database column that will be used to match the filter text (used with "list_filter_text").

Type xsd:string.

list_filter_text

Optional. The text that will be used to filter results.

Type xsd:string.

list_page_offset

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.

list_page_size

Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").

Type xsd:integer.

Default is 25.

list_record_offset

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.

list_sort_column

Optional. The column to sort with (used with "list_ascending").

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<listInteractionsResponse 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>0</interactionTypeId>
    <categoryId>1000</categoryId>
    <referenceId>0</referenceId>
    <consId>1001001</consId>
    <createdBy>1001001</createdBy>
    <creationDate>2016-02-01T09:43:35.288-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.288-06:00</creationDate>
      <interactionId>1000</interactionId>
      <modifiedBy>1001001</modifiedBy>
      <modifiedDate>2016-02-01T09:43:35.288-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>1</interactionTypeId>
    <categoryId>1001</categoryId>
    <referenceId>0</referenceId>
    <consId>1001002</consId>
    <createdBy>1001002</createdBy>
    <creationDate>2016-02-01T09:43:35.288-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.288-06:00</creationDate>
      <interactionId>1001</interactionId>
      <modifiedBy>1001002</modifiedBy>
      <modifiedDate>2016-02-01T09:43:35.288-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>2</interactionTypeId>
    <categoryId>1002</categoryId>
    <referenceId>0</referenceId>
    <consId>1001003</consId>
    <createdBy>1001003</createdBy>
    <creationDate>2016-02-01T09:43:35.288-06:00</creationDate>
    <subject>Sample Subject 2</subject>
    <count>3</count>
    <note>
      <categoryId>1002</categoryId>
      <typeOfConsNote>normal</typeOfConsNote>
      <consId>1001003</consId>
      <createdBy>1001003</createdBy>
      <creationDate>2016-02-01T09:43:35.288-06:00</creationDate>
      <interactionId>1002</interactionId>
      <modifiedBy>1001003</modifiedBy>
      <modifiedDate>2016-02-01T09:43:35.288-06:00</modifiedDate>
      <noteId>1002</noteId>
      <subject>Sample Subject 2</subject>
      <text>Lorem ipsum dolor sit amet, consetetur sadipscing 2</text>
      <type>comment</type>
    </note>
  </interaction>
</listInteractionsResponse>

JSON response

{"listInteractionsResponse":{"interaction":[{"creationDate":"2016-02-01T09:43:35.288-06:00","interactionTypeId":"0","count":"1","createdBy":"1001001","consId":"1001001","interactionId":"1000","subject":"Sample Subject 0","categoryId":"1000","referenceId":"0","note":{"creationDate":"2016-02-01T09:43:35.288-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.288-06:00"}},{"creationDate":"2016-02-01T09:43:35.288-06:00","interactionTypeId":"1","count":"2","createdBy":"1001002","consId":"1001002","interactionId":"1001","subject":"Sample Subject 1","categoryId":"1001","referenceId":"0","note":{"creationDate":"2016-02-01T09:43:35.288-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.288-06:00"}},{"creationDate":"2016-02-01T09:43:35.288-06:00","interactionTypeId":"2","count":"3","createdBy":"1001003","consId":"1001003","interactionId":"1002","subject":"Sample Subject 2","categoryId":"1002","referenceId":"0","note":{"creationDate":"2016-02-01T09:43:35.288-06:00","text":"Lorem ipsum dolor sit amet, consetetur sadipscing 2","interactionId":"1002","createdBy":"1001003","consId":"1001003","typeOfConsNote":"normal","subject":"Sample Subject 2","modifiedBy":"1001003","categoryId":"1002","noteId":"1002","type":"comment","modifiedDate":"2016-02-01T09:43:35.288-06:00"}}]}}

listInteractions

Client API Syntax

Server API Syntax

Client API Parameters

Server API Parameters

Response

Leave a Comment