getCompanyPhoto

Retrieves the company photo for a team.

2019 Update: To execute this method successfully, either include a company coordinator's constituent ID in the cons_id parameter, or have a logged-in company coordinator make the call for authentication. If the company coordinator's constituent ID is not provided, and the call is not made by a logged-in company coordinator, an error occurs. When both a cons_id is provided and a logged in company coordinator makes the call, the constituent identified in the parameter is used.

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

Client API Syntax

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

Client API Parameters

Common Client Parameters

See topic Common Parameters.

company_id

Required. The unique ID of the company.

Type xsd:nonNegativeInteger.

cons_id

Optional. The constituent ID of the company coordinator. Authentication of a logged-in company coordinator making this call is not required as long as the company coordinator's 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"?>
<getCompanyPhotoResponse 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>
</getCompanyPhotoResponse>

JSON response

{"getCompanyPhotoResponse":{"photoItem":{"customUrl":"","id":"1","originalUrl":"","thumbnailUrl":""}}}

Luminate Online

getCompanyPhoto

Client API Syntax

Client API Parameters

Response

Leave a Comment