getTeamPageInfo

Provides information used to display or edit a team page.

2019 Update: This method no longer requires a logged-in Team Captain to make the call for authentication when either a Team Captain ID is provided in the cons_id parameter or a Team ID is provided in the team_id parameter. When the call includes a cons_id or team_id, that value is used even when the call is made by a logged-in Team Captain. If no Team ID or Team Captain ID is provided, and the call is not made by a logged-in Team Captain, an error occurs.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRTeamraiserAPI	None.	POST	No.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getTeamPageInfo &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 ] &fr_id=value [ &cons_id=value ] [ &team_id=value ] [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

cons_id

Optional. The constituent ID of the Team Captain. When this method is provided with either this value or the Team ID in the team_id parameter, a logged-in Team Captain is not required to make the call.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

team_id

Optional. The Team ID. When this method is provided with either this value or the Team Captain's constituent ID in the cons_id parameter, a logged-in Team Captain is not required to make the call.

Type xsd:nonNegativeInteger.

auth

Optional. When not using the cons_id or team_id parameters, 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 Luminate web page.

sso_auth_token

Optional. When not using the cons_id or team_id parameters, 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 response

<?xml version="1.0" encoding="UTF-8"?>
<getTeamPageResponse 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">
  <teamPage>
    <description>Sample Team Page Description</description>
    <richText>&lt;P>Sample Team Page rich text.&lt;/P></richText>
    <richTextEnabled>true</richTextEnabled>
  </teamPage>
</getTeamPageResponse>

JSON response

{"getTeamPageResponse":{"teamPage":{"richTextEnabled":"true","description":"Sample Team Page Description","richText":"<P>Sample Team Page rich text.<\/P>"}}}

Luminate Online

getTeamPageInfo

Client API Syntax

Client API Parameters

Response

Leave a Comment