Luminate Online

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

Client API Syntax

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

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"?>
<getSuggestedMessagesResponse 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">
  <suggestedMessage>
    <messageId>100</messageId>
    <name>Sample Layout 01</name>
    <messageType>THANKS</messageType>
    <personal>false</personal>
    <active>true</active>
  </suggestedMessage>
  <suggestedMessage>
    <messageId>101</messageId>
    <name>Sample Layout 11</name>
    <messageType>THANKS</messageType>
    <personal>false</personal>
    <active>true</active>
  </suggestedMessage>
  <suggestedMessage>
    <messageId>102</messageId>
    <name>Sample Layout 21</name>
    <messageType>THANKS</messageType>
    <personal>false</personal>
    <active>true</active>
  </suggestedMessage>
  <suggestedMessage>
    <messageId>103</messageId>
    <name>Sample Layout 31</name>
    <messageType>THANKS</messageType>
    <personal>false</personal>
    <active>true</active>
  </suggestedMessage>
  <suggestedMessage>
    <messageId>104</messageId>
    <name>Sample Layout 41</name>
    <messageType>THANKS</messageType>
    <personal>false</personal>
    <active>true</active>
  </suggestedMessage>
</getSuggestedMessagesResponse>

JSON response

{"getSuggestedMessagesResponse":{"suggestedMessage":[{"personal":"false","name":"Sample Layout 01","active":"true","messageType":"THANKS","messageId":"100"},{"personal":"false","name":"Sample Layout 11","active":"true","messageType":"THANKS","messageId":"101"},{"personal":"false","name":"Sample Layout 21","active":"true","messageType":"THANKS","messageId":"102"},{"personal":"false","name":"Sample Layout 31","active":"true","messageType":"THANKS","messageId":"103"},{"personal":"false","name":"Sample Layout 41","active":"true","messageType":"THANKS","messageId":"104"}]}}

getSuggestedMessages

Client API Syntax

Client API Parameters

Response

Leave a Comment