Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

group_id

Optional. A unique ID of the group.

Type xsd:integer.

group_ids

Optional. A comma-separated list of groups IDs.

Type xsd:string.

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"?>
<getTeamraiserAddressBookGroupContactsResponse 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">
  <addressBookContact>
    <id>1123</id>
    <firstName>firstName</firstName>
    <lastName>lastName</lastName>
    <email>example+1123@example.com</email>
  </addressBookContact>
</getTeamraiserAddressBookGroupContactsResponse>

        

{"getTeamraiserAddressBookGroupContactsResponse":{"addressBookContact":{"id":"1123","lastName":"lastName","email":"example+1123@example.com","firstName":"firstName"}}}