getParticipantCenterWrapper

Provides a rendered HTML block for use at the top of the participant center as well as related links.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getParticipantCenterWrapper &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

Usage Notes

This method can be called anonymously, however, if you do not call this method within the context of a logged-in user, you must specify a valid Constituent ID as a cons_id parameter; otherwise the method will return an error.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<getParticipantCenterWrapperResponse 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">
  <wrapper>
    <eventId>1234</eventId>
    <logoutUrl>http://example.com/logouturl</logoutUrl>
    <helpLinkUrl>http://example.com/helpurl</helpLinkUrl>
    <personalPageUrl>http://example.com/personalpageurl</personalPageUrl>
    <teamPageUrl>http://example.com/teampageurl</teamPageUrl>
    <companyPageUrl>http://example.com/companyurl</companyPageUrl>
    <organizationName>Sample Organization Name</organizationName>
    <eventName>Sample Event Name</eventName>
    <teamName>Sample Team Name</teamName>
    <companyName>Sample Company Name</companyName>
    <content>&lt;P>Sample HTML wrapper content.&lt;/P></content>
    <shareProvider>FACEBOOK</shareProvider>
    <shareProvider>TWITTER</shareProvider>
    <shareTitle>Support me</shareTitle>
    <shareAction>Donate</shareAction>
    <shareMessage>View my page</shareMessage>
    <shareId>EDP content</shareId>
  </wrapper>
</getParticipantCenterWrapperResponse>

        
JSON response
{"getParticipantCenterWrapperResponse":{"wrapper":{"teamName":"Sample Team Name","logoutUrl":"http://example.com/logouturl","organizationName":"Sample Organization Name","shareTitle":"Support me","companyName":"Sample Company Name","shareProvider":["FACEBOOK","TWITTER"],"content":"<P>Sample HTML wrapper content.<\/P>","shareMessage":"View my page","teamPageUrl":"http://example.com/teampageurl","companyPageUrl":"http://example.com/companyurl","shareId":"EDP content","eventId":"1234","helpLinkUrl":"http://example.com/helpurl","personalPageUrl":"http://example.com/personalpageurl","eventName":"Sample Event Name","shareAction":"Donate"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: