WildApricot · JSON Structure

Wildapricot Event Registration Type Structure

EventRegistrationType schema from WildApricot Admin API

Type: object Properties: 21
Membership ManagementAssociationsNonprofitEventsPayments

EventRegistrationType is a JSON Structure definition published by WildApricot, describing 21 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Id Url IsEnabled EventId Name Description BasePrice GuestPrice UseTaxScopeSettings Availability RegistrationCode AvailableForMembershipLevels AvailableFrom AvailableThrough MaximumRegistrantsCount CurrentRegistrantsCount GuestRegistrationPolicy UnavailabilityPolicy CancellationBehaviour CancellationDaysBeforeEvent IsWaitlistEnabled

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wildapricot/refs/heads/main/json-structure/wildapricot-event--registration--type-structure.json",
  "description": "EventRegistrationType schema from WildApricot Admin API",
  "type": "object",
  "properties": {
    "Id": {
      "type": "int32",
      "description": "Unique event registration type identifier."
    },
    "Url": {
      "$ref": "#/components/schemas/ResourceUrl"
    },
    "IsEnabled": {
      "type": "boolean",
      "description": "Indicates whether this registration type is enabled"
    },
    "EventId": {
      "type": "int32",
      "description": "Identifier of event related to the registration type."
    },
    "Name": {
      "type": "string",
      "description": "Registraton type title."
    },
    "Description": {
      "type": "string",
      "description": "Plain text description for the event registration type."
    },
    "BasePrice": {
      "type": "double",
      "description": "Base price registrant pays for this registration type."
    },
    "GuestPrice": {
      "type": "double",
      "description": "Price for each additional guest."
    },
    "UseTaxScopeSettings": {
      "type": "boolean",
      "description": "Indicates whether account tax scope settings should be used to calculate final price."
    },
    "Availability": {
      "$ref": "#/components/schemas/EventRegistrationTypeAvailability"
    },
    "RegistrationCode": {
      "type": "string",
      "description": "Registration code required to apply for event with this registration type. This property has value only if Availability is CodeRequired."
    },
    "AvailableForMembershipLevels": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LinkedResource"
      },
      "description": "Which membership levels can apply for event. This property has value only if Availability is MembersOnly."
    },
    "AvailableFrom": {
      "type": "string",
      "description": "This registration type is available starting from this date. Can be null."
    },
    "AvailableThrough": {
      "type": "string",
      "description": "This registration type is available until this date. Can be null."
    },
    "MaximumRegistrantsCount": {
      "type": "int32",
      "description": "Maximum number of registrants for this registration type."
    },
    "CurrentRegistrantsCount": {
      "type": "int32",
      "description": "Current number of registrants for this registration type."
    },
    "GuestRegistrationPolicy": {
      "$ref": "#/components/schemas/EventGuestRegistrationPolicy"
    },
    "UnavailabilityPolicy": {
      "$ref": "#/components/schemas/EventRegistrationUnavailabilityPolicy"
    },
    "CancellationBehaviour": {
      "$ref": "#/components/schemas/EventRegistrationCancellationBehavior"
    },
    "CancellationDaysBeforeEvent": {
      "type": "int32",
      "description": "In case if CancellationBehaviour = AllowUpToPeriodBeforeEvent, this field indicates the minimum number of days before the event that cancellations are allowed."
    },
    "IsWaitlistEnabled": {
      "type": "boolean",
      "description": "Indicated if registrant should be added to waitlist if registrations have reached their limit."
    }
  },
  "name": "EventRegistrationType"
}