uploadCompanyPhoto

Uploads a company page photo. If the graphic_upload_file is blank, the photo caption will be the only item updated. The photo must be submitted in encoding type 'multipart/form-data'.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=uploadCompanyPhoto &api_key=value &v=value [ &auth=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=value [ &photo1_text=value ] [ &photo_1_file=value ] [ &photo_1_upload=value ] [ &responsive_company_logo_file=value ] [ &responsive_company_logo_upload=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.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

photo1_text

Optional. The photo caption for the team photo

photo_1_file

Optional. The name of the team photo to be uploaded.

photo_1_upload

Optional. Indicates whether team photo should be updated.

responsive_company_logo_file

Optional. The name of the team photo to be uploaded.

responsive_company_logo_upload

Optional. Indicates whether team photo should be updated.

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 response

<?xml version="1.0" encoding="UTF-8"?>
<uploadCompanyPhotoResponse 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>123</id>
    <thumbnailUrl>http://www.example.com/thumbnailexample.jpg</thumbnailUrl>
  </photoItem>
</uploadCompanyPhotoResponse>

JSON response

{"uploadCompanyPhotoResponse":{"photoItem":{"id":"123","thumbnailUrl":"http://www.example.com/thumbnailexample.jpg"}}}

Luminate Online

uploadCompanyPhoto

Client API Syntax

Client API Parameters

Response

Leave a Comment