getCompanyPageInfo

Provides information used to display or edit a company page.

2019 Update: To execute this method successfully, either include a company coordinator's constituent ID in the cons_id parameter, or have a logged-in company coordinator make the call for authentication. If the company coordinator's constituent ID is not provided, and the call is not made by a logged-in company coordinator, an error occurs.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRTeamraiserAPI None. POST No.

Client API Syntax

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

cons_id

Optional. The constituent ID of the company coordinator. Authentication of a logged-in company coordinator making this call is not required as long as the company coordinator's constituent ID is provided.

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"?>
<getCompanyPageResponse 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">
  <companyPage>
    <pageTitle>Sample Page Title</pageTitle>
    <richTextEnabled>true</richTextEnabled>
    <richText>&lt;p>Sample HTML.&lt;/p></richText>
  </companyPage>
</getCompanyPageResponse>

        
JSON response
{"getCompanyPageResponse":{"companyPage":{"pageTitle":"Sample Page Title","richText":"

Sample HTML.","richTextEnabled":"true"}}}

Leave a Comment

Nickname
Comment
Enter this word: