Returns the details of all well-known TeamRaiser public event types that match the search criteria.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRTeamraiserAPI | None. | GET, POST | No. |
This method was designed primarily to support the dynamic creation of TeamRaiser search forms via REST APIs. You could, for example, invoke this method to discover valid public event type names to be included in an HTTP search form.
Of particular importance when using this method is the relationship between public event types and primary event types. Every primary event type is associated with zero or more public event types. Conversely, a public event type is associated with exactly one primary event type. That relationship has important consequences for TeamRaiser search forms. TeamRaiser search forms that constrain search results by primary event type should pass that same primary event constraint to this method when requesting a list of valid public event types.
See topic Common Parameters.
Optional. A value of true indicates that only currently active public event types should be returned in the search results. Defaults to true.
Type xsd:boolean.
Optional. The name of the primary event type to limit search results to. Omit this parameter to search for public event types associated with any primary event type. Defaults to null.
Type xsd:string.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<getPublicEventTypesResponse 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">
<totalNumberResults>3</totalNumberResults>
<publicEventType>
<publicEventTypeName>Marathon</publicEventTypeName>
<primaryEventTypeName>Endurance Event</primaryEventTypeName>
<active>true</active>
</publicEventType>
<publicEventType>
<publicEventTypeName>Run/Walk</publicEventTypeName>
<primaryEventTypeName>Endurance Event</primaryEventTypeName>
<active>false</active>
</publicEventType>
<publicEventType>
<publicEventTypeName>10 K</publicEventTypeName>
<primaryEventTypeName>Endurance Event</primaryEventTypeName>
<active>true</active>
</publicEventType>
</getPublicEventTypesResponse>
JSON response
{"getPublicEventTypesResponse":{"publicEventType":[{"publicEventTypeName":"Marathon","primaryEventTypeName":"Endurance Event","active":"true"},{"publicEventTypeName":"Run/Walk","primaryEventTypeName":"Endurance Event","active":"false"},{"publicEventTypeName":"10 K","primaryEventTypeName":"Endurance Event","active":"true"}],"totalNumberResults":"3"}}
To find a list of all valid, active public event types:
https://demo-secure.convio.net/demo829/site/CRTeamraiserAPI?api_key=MyAPIKey&v=1.0&method=getPublicEventTypes
To request a list of active public event types that are appropriate for the 'Foo' primary event type:
https://demo-secure.convio.net/demo829/site/CRTeamraiserAPI?api_key=MyAPIKey&v=1.0&method=getPublicEventTypes&event_type=Foo
To request a complete listing of active and non-active public event types:
https://demo-secure.convio.net/demo829/site/CRTeamraiserAPI?api_key=MyAPIKey&v=1.0&method=getPublicEventTypes&active_only=false