Templates

The following operations are available for this resource.

Http Verb Operation
Get Templates/{templateId} Get the details of a template by id
GET Method: Get, URL: Templates/{templateId} Test

Get the details of a template by id

GetAll Templates Get all templates
GET Method: GetAll, URL: Templates Test

Get all templates

GetSummaries Templates/Summaries Get a summary representation of all templates
GET Method: GetSummaries, URL: Templates/Summaries Test

Get a summary representation of all templates

Create Templates Create a new template
POST Method: Create, URL: Templates Test

Create a new template

GetConstituentInfo Templates/{templateId}/Constituent/{constituentId}/Info Get a formatted html body for constituent info
POST Method: GetConstituentInfo, URL: Templates/{templateId}/Constituent/{constituentId}/Info Test

Get a formatted html body for constituent info

GetLoginCredentials Templates/{templateId}/Login/{loginId}/Credentials Get a formatted html body for login credentials. This endpoint will not generate a password token and should be used for testing a login credentials template. Use the SendCredentials endpoint in Web/Session to send a login credentials email with a generated password token.
POST Method: GetLoginCredentials, URL: Templates/{templateId}/Login/{loginId}/Credentials Test

Get a formatted html body for login credentials.

GetOrderConfirmation Templates/{templateId}/Order/{orderId}/Confirmation Get a formatted html body for an order confirmation
POST Method: GetOrderConfirmation, URL: Templates/{templateId}/Order/{orderId}/Confirmation Test

Get a formatted html body for an order confirmation

GetTickets Templates/{templateId}/Order/{orderId}/Tickets Get a formatted html body for tickets Composite tickets are not currently supported, so a request to print one will instead return ticket elements for each performance, as if no composite ticket design had been selected for the package.
POST Method: GetTickets, URL: Templates/{templateId}/Order/{orderId}/Tickets Test

Get a formatted html body for tickets

RenderConstituentInfo Templates/Render/Constituent/{constituentId}/Info Return the rendered constituent info template for the provided constituent Id
POST Method: RenderConstituentInfo, URL: Templates/Render/Constituent/{constituentId}/Info Test

Return the rendered constituent info template for the provided constituent Id

RenderLoginCredentials Templates/Render/Login/{loginId}/Credentials Return the rendered login credentials template for the provided web login id This endpoint will not generate a password token and should be used for testing a login credentials template. Use the SendCredentials endpoint in Web/Session to send a login credentials email with a generated password token.
POST Method: RenderLoginCredentials, URL: Templates/Render/Login/{loginId}/Credentials Test

Return the rendered login credentials template for the provided web login id

RenderOrderConfirmation Templates/Render/Order/{orderId}/Confirmation Return the rendered order confirmation template for the provided order Id
POST Method: RenderOrderConfirmation, URL: Templates/Render/Order/{orderId}/Confirmation Test

Return the rendered order confirmation template for the provided order Id

RenderTickets Templates/Render/Order/{orderId}/Tickets Return the rendered tickets for the provided order Id Composite tickets are not currently supported, so a request to print one will instead return ticket elements for each performance, as if no composite ticket design had been selected for the package.
POST Method: RenderTickets, URL: Templates/Render/Order/{orderId}/Tickets Test

Return the rendered tickets for the provided order Id

Update Templates/{templateId} Update an existing template
PUT Method: Update, URL: Templates/{templateId} Test

Update an existing template

Delete Templates/{templateId} Delete a template
DELETE Method: Delete, URL: Templates/{templateId} Test

Delete a template