getCaptainsMessage

Provides the message a team captain writes to the team and whether or not a participant can edit that message.

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=getCaptainsMessage &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

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"?>
<getCaptainsMessageResponse 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">
  <message>Sample captains message.</message>
  <editable>false</editable>
</getCaptainsMessageResponse>
JSON response 
{"getCaptainsMessageResponse":{"message":"Sample captains message.","editable":"false"}}
Parent topic: TeamRaiser API
Previous topic: getCampaignByNameData
Next topic: getCompaniesByInfo

Comments

Submitted by linxdev at 08:23 AM on July 28, 2013
Response has message as an object, not as a string. This is the response I get {"getCaptainsMessageResponse":{"editable":"false","message":{}}}

Leave a Comment

Nickname
Comment
Enter this word:
Change