Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

video_url

Required. The URL to the video.

Note: Starting with the 17.8 Luminate Online release, this method strictly enforces this parameter and the presence of valid or blank URLs. Exceptions occur when an invalid URL is provided.  

Examples of valid inputs include:

     /site/CRTeamraiserAPI?method=updatePersonalVideoUrl&v=1.0&api_key=api_key&sso_auth_token=123&video_url=http://www.test.com&fr_id=1000

     /site/CRTeamraiserAPI?method=updatePersonalVideoUrl&v=1.0&api_key=api_key&sso_auth_token=123&video_url=&fr_id=1000

     /site/CRTeamraiserAPI?method=updatePersonalVideoUrl&v=1.0&api_key=api_key&sso_auth_token=123&fr_id=1000&video_url=

Example of an invalid input that is missing this parameter:

     /site/CRTeamraiserAPI?method=updatePersonalVideoUrl&v=1.0&api_key=api_key&sso_auth_token=123&fr_id=1000

Type xsd:anyURI.

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 version="1.0" encoding="UTF-8"?>
<updatePersonalVideoUrlResponse 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">
  <videoUrl xsi:nil="true"/>
</updatePersonalVideoUrlResponse>

JSON response
{"updatePersonalVideoUrlResponse":{"videoUrl":null}}