WildApricot · JSON Structure

Wildapricot Event Structure

Event schema from WildApricot Admin API

Type: object Properties: 20 Required: 5
Membership ManagementAssociationsNonprofitEventsPayments

Event is a JSON Structure definition published by WildApricot, describing 20 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Id Url Name EventType StartDate StartTimeSpecified EndDate EndTimeSpecified Location RegistrationEnabled HasEnabledRegistrationTypes AccessLevel Tags Details Sessions RegistrationsLimit InviteeStat PendingRegistrationsCount ConfirmedRegistrationsCount CheckedInAttendeesNumber

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-structure.json",
  "description": "Event schema from WildApricot Admin API",
  "type": "object",
  "properties": {
    "Id": {
      "type": "int32",
      "description": "Unique event identifier"
    },
    "Url": {
      "$ref": "#/components/schemas/ResourceUrl"
    },
    "Name": {
      "type": "string",
      "description": "Event title"
    },
    "EventType": {
      "type": "string",
      "enum": [
        "Reqular",
        "RSVP"
      ],
      "description": "Indicates if event is simple (RSVP) or regular."
    },
    "StartDate": {
      "type": "string",
      "description": "Date and time when the event is scheduled to start."
    },
    "StartTimeSpecified": {
      "type": "boolean",
      "description": "Indicates if event start time is specified. False means that StartDate contains only date component."
    },
    "EndDate": {
      "type": "string",
      "description": "Date and time when the event is scheduled to end. Could be empty."
    },
    "EndTimeSpecified": {
      "type": "boolean",
      "description": "Indicates if event end time is specified. False means that EndDate contains only date component."
    },
    "Location": {
      "type": "string",
      "description": "Location where the event will take place."
    },
    "RegistrationEnabled": {
      "type": "boolean",
      "description": "Indicates whether registration to this event is enabled"
    },
    "HasEnabledRegistrationTypes": {
      "type": "boolean",
      "description": "Indicates that at least one registration type is enabled for this event."
    },
    "AccessLevel": {
      "$ref": "#/components/schemas/EventAccessLevel"
    },
    "Tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A collection of tags associated with the event."
    },
    "Details": {
      "$ref": "#/components/schemas/EventDetails"
    },
    "Sessions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EventSesssion"
      },
      "description": "Collection of event sessions. Exist in multisessions events only."
    },
    "RegistrationsLimit": {
      "type": "int32",
      "description": "Maximum number of registrations for this event."
    },
    "InviteeStat": {
      "$ref": "#/components/schemas/EventInviteeStatistics"
    },
    "PendingRegistrationsCount": {
      "type": "int32",
      "description": "Number of participants already registered for this event but not confirmed yet."
    },
    "ConfirmedRegistrationsCount": {
      "type": "int32",
      "description": "Number of participants already registered for this event and already confirmed."
    },
    "CheckedInAttendeesNumber": {
      "type": "int32",
      "description": "Number of attendees already checked in on this event."
    }
  },
  "required": [
    "Id",
    "Url",
    "Name",
    "EventType",
    "StartDate"
  ],
  "name": "Event"
}