getPersonalPagePreview

Provides a preview of the personal page.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getPersonalPagePreview &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 [ &blog_enabled=value ] [ &headline1=value ] [ &headline2=value ] [ &headline3=value ] [ &page_layout=value ] [ &page_title=value ] [ &rich_text=value ] [ &status1=value ] [ &status2=value ] [ &text1=value ] [ &text2=value ] [ &text3=value ] [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

blog_enabled

Optional. Whether or not your personal page blog is enabled.

Type xsd:boolean.

headline1

Optional. The first headline on the page.

Type xsd:string.

headline2

Optional. The second headline on the page.

Type xsd:string.

headline3

Optional. The third headline on the page.

Type xsd:string.

page_layout

Optional. The selected page layout

page_title

Optional. The title of the page

rich_text

Optional. The rich text area of the page.

Type xsd:string.

status1

Optional. Status Indicator 1

Type xsd:string.

status2

Optional. Status Indicator 2

Type xsd:string.

text1

Optional. The first text area on the page.

Type xsd:string.

text2

Optional. The second text area on the page.

Type xsd:string.

text3

Optional. The third text area on the page.

Type xsd:string.

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"?>
<getPersonalPagePreviewResponse 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">
  <previewUrl>http://www.example.com/preview.html</previewUrl>
</getPersonalPagePreviewResponse>

        
JSON response
{"getPersonalPagePreviewResponse":{"previewUrl":"http://www.example.com/preview.html"}}

        

Leave a Comment

Nickname
Comment
Enter this word: