getTeamPhoto

Retrieves the team photo for a team.

2019 Update: When a Team Captain ID is provided in the cons_id parameter, this method no longer requires a logged-in constituent to make the call for authentication. If no Team Captain ID is provided, and the call is not made by a logged-in Team Captain, an error occurs. When both a cons_id is provided and a logged-in Team Captain makes the call, the Team Captain identified in the parameter is used.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRTeamraiserAPI None. POST No.

Client API Syntax

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

Usage Notes

To execute this method successfully, you must either include the Team Captain's constituent ID in the cons_id parameter, or the call must be made by a logged-in user who is a Team Captain.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

cons_id

Optional. The constituent ID of the Team Captain. Authentication of a logged-in Team Captain making this call is not required as long as the Team Captain constituent ID is provided.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

auth

Optional. When not using the cons_id parameter, 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 parameter, 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"?>
<getTeamPhotoResponse 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">
  <photoItem>
    <id>1</id>
    <thumbnailUrl>&lt;url></thumbnailUrl>
    <customUrl>&lt;url></customUrl>
    <originalUrl>&lt;url></originalUrl>
  </photoItem>
</getTeamPhotoResponse>

        
JSON response
{"getTeamPhotoResponse":{"photoItem":{"customUrl":"<url>","id":"1","originalUrl":"<url>","thumbnailUrl":"<url>"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: