Returns the team roster for a given team id
Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
---|---|---|---|
CRTeamraiserAPI | None. | GET, POST | Yes. |
See topic Common Parameters.
Required. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
Required. A unique team ID
Type xsd:nonNegativeInteger.
Optional. Specifies whether a url to download the data should be included in the response.
Type xsd:boolean.
Optional. Whether the list should be sorted in ascending order.
Type xsd:boolean.
Default is true.
Optional. Security Category filter.
Type xsd:integer.
Optional. The database column that will be used to match the filter text (used with "list_filter_text").
Type xsd:string.
Optional. The text that will be used to filter results.
Type xsd:string.
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.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
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.
Optional. The column to sort with (used with "list_ascending").
Type xsd:string.
Optional. Setting to only return team members with a positive amount if set to REQUIRED.
Type xsd:boolean.
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.
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.
See topic HTTP Status Codes.
XML response<?xml version="1.0" encoding="UTF-8"?> <getTeamRosterResponse 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"> <teamMember> <firstName>first1</firstName> <lastName>lastname</lastName> <email>example1@example.com</email> <amount>1001</amount> <aTeamCaptain>false</aTeamCaptain> <consId>1001001</consId> </teamMember> <teamMember> <firstName>first2</firstName> <lastName>lastname</lastName> <email>example2@example.com</email> <amount>1002</amount> <aTeamCaptain>false</aTeamCaptain> <consId>1001002</consId> </teamMember> <teamMember> <firstName>first3</firstName> <lastName>lastname</lastName> <email>example3@example.com</email> <amount>1003</amount> <aTeamCaptain>false</aTeamCaptain> <consId>1001003</consId> </teamMember> </getTeamRosterResponse>JSON response
{"getTeamRosterResponse":{"teamMember":[{"amount":"1001","aTeamCaptain":"false","lastName":"lastname","consId":"1001001","email":"example1@example.com","firstName":"first1"},{"amount":"1002","aTeamCaptain":"false","lastName":"lastname","consId":"1001002","email":"example2@example.com","firstName":"first2"},{"amount":"1003","aTeamCaptain":"false","lastName":"lastname","consId":"1001003","email":"example3@example.com","firstName":"first3"}]}}