getMessageLayouts

Provides a list of available message layouts or stationeries.

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

Client API Syntax

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 Luminate Online 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"?>
<getMessageLayoutsResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.teamraiser.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <layout>
  <layoutId>100</layoutId>
  <name>Sample layout 0</name>
  <thumbnailUrl>http://example.com/sample0.jpg</thumbnailUrl>
  </layout>
  <layout>
  <layoutId>101</layoutId>
  <name>Sample layout 1</name>
  <thumbnailUrl>http://example.com/sample1.jpg</thumbnailUrl>
  </layout>
  <layout>
  <layoutId>102</layoutId>
  <name>Sample layout 2</name>
  <thumbnailUrl>http://example.com/sample2.jpg</thumbnailUrl>
  </layout>
</getMessageLayoutsResponse>

JSON response

JSON

{"getMessageLayoutsResponse":{"layout":[{"name":"Sample layout 0","layoutId":"100","thumbnailUrl":"http://example.com/sample0.jpg"},{"name":"Sample layout 1","layoutId":"101","thumbnailUrl":"http://example.com/sample1.jpg"},{"name":"Sample layout 2","layoutId":"102","thumbnailUrl":"http://example.com/sample2.jpg"}]}}