Home

Download this help site
(PDF 82MB)

Download

EventRegistrationTypes API V2 call 

Icon

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

You can use the EventRegistrationTypes API call to retrieve the details for an existing event registration type, or for all existing event registration type within an event. You can also create, update, and delete event registration types.

Retrieving details for an event registration type

Using the EventRegistrationTypes API call, you can retrieve details for an existing registration type.

Syntax

Example:

Retrieving registration type details for an event

Using the EventRegistrationTypes API call, you can retrieve details for all registration types for a particular event.

Syntax

Example:

Parameters

The following parameters are used within the EventRegistrationTypes API call:

Variable

Description

baseAPIaddress

The base address of the API. For more information, see API access options   .

accountID

The account identifier that appears on the Account and billing screen and is returned by the Accounts API call.

typeIDThe unique identifier for an event registration type. Registration types IDs are returned by the EventRegistrationTypes call.
{eventID}The unique identifier of an event. Event IDs are returned by the Events API call.
Icon

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see Authenticating API access from a 3rd-party server or application or Authenticating API access from a Wild Apricot site page.

Response fields

If the call is unsuccessful, it returns HTTP 400. If successful, it retrieves the following information.

Field

Description

EventIDUnique identifier of the event.
IsEnabledIndicates whether the registration type is enabled.
DescriptionDescription of the registration type.
GuestRegistrationPolicyIndicates whether registrants can register guests at the same time that they submit their own registration. Possible values are:
  • Disabled – guest registration is not allowed.
  • NumberOfGuests – specify just the number of guests.
  • CollectContactDetails – contact information collected for each guest.
  • CollectFullInfo – full registration information collected for each guest.
BasePriceBase price for the registration type.
GuestPricePrice for guest registrations.
UseTaxScopeSettingsIndicates whether tax scope settings are followed for this registration type.
AvailabilityIndicates whether this registration type is available to everyone, just certain membership levels, or to anyone with the registration code. Possible values are: Everyone, MembersOnly, CodeRequired
AvailableForMembershipLevels(If Availability = MembersOnly) Indicates which membership levels can use this registration type.
RegistrationCode(If Availability = CodeRequired) The registration code.
AvailableFromThe date the registration type is available from. Possible values include null.
AvailableThroughThe date the registration type is available until. Possible values include null.
MaximumRegistrantsCountThe maximum number of registrants for this registration type.
CurrentRegistrantsCountCurrent number of registrants for this registration type.
MultipleRegistrationAllowedIndicates whether contacts can register multiple times for the same event.
UnavailabilityPolicy Indicates what appears if this registration type is not available for a particular visitor. Possible values are:
  • ShowDisabled
  • Hide
WaitlistBehaviourIndicates whether prospective registrants can join a waitlist after the registration limit is reached for this type, and how much information is collected from people wanting to join the waitlist. Possible values are:  
  • Disabled
  • RequestNameAndEmail
  • RequestContactInformation
  • RequestRegistrationInformation
IDThe unique identifier of the registration type.
URLThe address of the URL call for the registration type.
NameThe name used to identify the registration type.

Sample JSON response

Sample XML response

Creating a new registration type

You can use an EventRegistrationTypes API call to create a new event registration type.

Syntax

where registrationTypeField is a field returned by the EventRegistrationTypes API call.

Icon

The registration type Name and the event ID are required.

Example

If successful, the call will return the new event registration type ID.

If any of the required fields are missing, or if any of the fields include invalid data, a 400 Bad Request  error will be returned. For more information, see API V2 status codes.

Updating a registration type

You can update an existing registration type using an EventRegistrationTypes API call.

Syntax

where registrationTypeField is a field returned by the EventRegistrationTypes API call.

Icon
  • The registration type ID must be specified both as a field and within the requesting URL. All other registration type fields are optional.
  • You cannot update the eventID
  • If you update UseTaxScopeSettings, AvailableFrom, or AvailableThrough, you have to provide values with each future update, or else they will be reset to their default values of false and null, respectively.

Example

If successful, the call returns an HTTP status code 200 without any data in the response body.

Deleting a registration type

You can use an EventRegistrationTypes API call to delete an existing registration type.

Syntax

where typeID is the ID of the event registration type you want to delete.

Example

If successful, the call returns HTTP 200 Success. If unsuccessful, returns HTTP 400 bad request.

On this page:   

See also:

  • No labels