Events

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
get
/api/events
200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstring · uuidRead-onlyRequired
registeredstringRead-onlyRequired
checked_instringRead-onlyRequired
registrationsstringRead-onlyRequired
registration_countstringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
public_idstring · max: 7Optional
namestring · max: 255Required
descriptionstringRequired
start_timestring · date-timeRequired
end_timestring · date-timeRequired
bannerstring · max: 255 · nullableOptional
linkstring · uri · max: 200 · nullableOptional
requires_check_inbooleanOptional
requires_registrationbooleanOptional
is_recurringbooleanOptional
is_livestreambooleanOptional
recurrenceone of · nullableOptional
string · enumOptional
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • custom - Custom
Possible values:
or
undefined · enumOptionalPossible values:
or
undefined · enumOptionalPossible values:
recurrence_daysany · nullableOptional
recurrence_custom_patternstring · max: 50 · nullableOptional
recurrence_end_datestring · date · nullableOptional
imagesanyOptional
location_typestring · max: 50 · nullableOptional
Responses
chevron-right
201Success
application/json
post
/api/events
201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this event.

Responses
get
/api/events/{id}
200Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this event.

Body
idstring · uuidRead-onlyRequired
registeredstringRead-onlyRequired
checked_instringRead-onlyRequired
registrationsstringRead-onlyRequired
registration_countstringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
public_idstring · max: 7Optional
namestring · max: 255Required
descriptionstringRequired
start_timestring · date-timeRequired
end_timestring · date-timeRequired
bannerstring · max: 255 · nullableOptional
linkstring · uri · max: 200 · nullableOptional
requires_check_inbooleanOptional
requires_registrationbooleanOptional
is_recurringbooleanOptional
is_livestreambooleanOptional
recurrenceone of · nullableOptional
string · enumOptional
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • custom - Custom
Possible values:
or
undefined · enumOptionalPossible values:
or
undefined · enumOptionalPossible values:
recurrence_daysany · nullableOptional
recurrence_custom_patternstring · max: 50 · nullableOptional
recurrence_end_datestring · date · nullableOptional
imagesanyOptional
location_typestring · max: 50 · nullableOptional
Responses
put
/api/events/{id}
200Success
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this event.

Responses
delete
/api/events/{id}
204

No response body

No content

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this event.

Body
idstring · uuidRead-onlyOptional
registeredstringRead-onlyOptional
checked_instringRead-onlyOptional
registrationsstringRead-onlyOptional
registration_countstringRead-onlyOptional
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyOptional
public_idstring · max: 7Optional
namestring · max: 255Optional
descriptionstringOptional
start_timestring · date-timeOptional
end_timestring · date-timeOptional
bannerstring · max: 255 · nullableOptional
linkstring · uri · max: 200 · nullableOptional
requires_check_inbooleanOptional
requires_registrationbooleanOptional
is_recurringbooleanOptional
is_livestreambooleanOptional
recurrenceone of · nullableOptional
string · enumOptional
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • custom - Custom
Possible values:
or
undefined · enumOptionalPossible values:
or
undefined · enumOptionalPossible values:
recurrence_daysany · nullableOptional
recurrence_custom_patternstring · max: 50 · nullableOptional
recurrence_end_datestring · date · nullableOptional
imagesanyOptional
location_typestring · max: 50 · nullableOptional
Responses
patch
/api/events/{id}
200Success