getPersonalPageInfo

Provides information used to display or edit a personal page.

2019 Update: To execute this call successfully, include either the cons_id parameter, or have the logged-in participant whose personal page is being retrieved make this call. If the participant is logged-in and a different cons_id value is included, the call returns the page for the participant specified in the cons_id parameter.

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

Client API Syntax

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

Client API Parameters

Common Client Parameters

See topic Common Parameters.

cons_id

Optional. The constituent ID of the specific participant whose personal page is being retrieved. Authentication of this logged-in participant is not required as long as this value is included in the call. If this value is included and the call is made by a different logged-in participant, the returned page is for the participant specified in this parameter.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

auth

Optional. When not using the cons_id parameter, 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 web page.

sso_auth_token

Optional. When not using the cons_id parameter, 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"?>
<getPersonalPageResponse 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">
  <personalPage>
    <pageTitle>Sample Personal Page Title</pageTitle>
    <richText>&lt;P>Sample personal page rich text.&lt;/P></richText>
    <richTextEnabled>true</richTextEnabled>
    <availableLayouts>
      <layout>Single Photo/Status left edge</layout>
      <layout>Single Photo/Status block inset</layout>
      <layout>Two Photos Left</layout>
      <layout>Two Photos Right</layout>
      <layout>Customizable</layout>
    </availableLayouts>
  </personalPage>
</getPersonalPageResponse>

JSON response

{"getPersonalPageResponse":{"personalPage":{"availableLayouts":{"layout":["Single Photo/Status left edge","Single Photo/Status block inset","Two Photos Left","Two Photos Right","Customizable"]},"pageTitle":"Sample Personal Page Title","richText":"<P>Sample personal page rich text.<\/P>","richTextEnabled":"true"}}}

Luminate Online

getPersonalPageInfo

Client API Syntax

Client API Parameters

Response

Leave a Comment