Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

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.

search_email

Optional. Email to search for.

Type xsd:string.

search_first_name

Optional. First name of participant to search for.

Type xsd:string.

search_last_name

Optional. Last name of participant to search for.

Type xsd:string.

search_race_number

Optional. Race number to search for.

Type xsd:integer.

auth

Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.

sso_auth_token

Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<getTentingSearchResponse 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">
  <totalNumberResults>3</totalNumberResults>
  <record>
    <consId>1001000</consId>
    <eventId>1000</eventId>
    <tentmateStatus>0</tentmateStatus>
    <personalPageUrl>http://example.com/personal_page</personalPageUrl>
    <name>
      <first>Sam</first>
      <last>Ple0</last>
    </name>
  </record>
  <record>
    <consId>1001001</consId>
    <eventId>1001</eventId>
    <tentmateStatus>1</tentmateStatus>
    <personalPageUrl>http://example.com/personal_page</personalPageUrl>
    <name>
      <first>Sam</first>
      <last>Ple1</last>
    </name>
  </record>
  <record>
    <consId>1001002</consId>
    <eventId>1002</eventId>
    <tentmateStatus>2</tentmateStatus>
    <personalPageUrl>http://example.com/personal_page</personalPageUrl>
    <name>
      <first>Sam</first>
      <last>Ple2</last>
    </name>
  </record>
</getTentingSearchResponse>

        

{"getTentingSearchResponse":{"record":[{"tentmateStatus":"0","eventId":"1000","consId":"1001000","name":{"last":"Ple0","first":"Sam"},"personalPageUrl":"http://example.com/personal_page"},{"tentmateStatus":"1","eventId":"1001","consId":"1001001","name":{"last":"Ple1","first":"Sam"},"personalPageUrl":"http://example.com/personal_page"},{"tentmateStatus":"2","eventId":"1002","consId":"1001002","name":{"last":"Ple2","first":"Sam"},"personalPageUrl":"http://example.com/personal_page"}],"totalNumberResults":"3"}}