REST

getPersonalMediaLayout

Returns the value of the selected media type allowed to display on the TeamRaiser participant personal page.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRTeamraiserAPINone.POSTYes.

Client API Syntax

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

Usage Notes

Only image files are allowed if the returned value is photos. Only video files are allowed if the value is video.

This method is only compatible with the default one-photo personal page layout and the 2-photo personal page layout.

  • The 2-photo and 1-video layout allows both image and video files; therefore, it does not require a media type value.
  • Team pages only allow photos unless the 2-photo and 1-video layout is selected; therefore, no team page layouts require a media type value.
  • Company pages do not allow videos; therefore, no company page layouts require a media type value.

TeamRaiser Websites

Administrators can provide sponsoring companies, team captains, and participants customizable websites to assist with fundraising. This level of interaction and personalization encourages ownership and active participation at each level of involvement.

  • Participants – Allow participants to share event details, photos, and fundraising progress with family and friends. Related API methods include getPersonalMediaLayout, getPersonalPhotos, getPersonalVideoUrl, updatePersonalMediaLayout, updatePersonalVideoUrl, and uploadPersonalPhoto.
  • Teams – Allow team captains to market the event, solicit funds, check progress, set goals, and acknowledge achievements. Related API methods include getTeamraiserConfig, getTeamPhoto, getTeamVideoUrl, removeTeamPhoto, updateTeamVideoUrl, and uploadTeamPhoto.
  • Companies – Allow sponsors to run reports and access customer self-service options including registration and gift management. Related API methods include getTeamraiserConfig, getCompanyPhoto, removeCompanyPhoto, and uploadCompanyPhoto.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

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 Luminate Online 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"?>
<getPersonalMediaLayoutResponse 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">
  <personalMediaLayout>photos</personalMediaLayout>
</getPersonalMediaLayoutResponse>
JSON response
JSON 
{"getPersonalMediaLayoutResponse":{
  "personalMediaLayout":"photos"
}}