Loading ...

REST API: Events | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 40

REST API: Events

0 
 /5
0 (0votes)
Open API Guide

Programmatically create events, manage guest lists, and retrieve RSVP statuses. This API supports both physical and virtual event management within specific Spaces or at the global level.

Available Endpoints

Method Endpoint Description
POST Add Event Featured Image /api/events/{EventID}/image Set the featured image for events
PUT Add Space Members to Event /api/events/{EventID}/attendees Add all space members to an event as invitees or attendees
POST Add Users to an Event As Attendees /api/events/{EventID}/users Add individual users to an event as invitees or attendees
POST Create Event /api/events Create a new event on the intranet calendar. Events can include details like location, date range, recurrence settings, and attendee invitations.
POST Create Event Resource /api/events/resources Provides programmatic access for the creation and processing of save resource resources.
POST Create Event Type /api/eventtypes Provides programmatic access for the creation and processing of add edit event type resources.
PUT Create Reminder /api/events/reminder Facilitates the addition of a reminder for a particular event.
DELETE Delete Event /api/events/{EventID} Permanently remove an event from the intranet calendar by its ID. This deletes the event along with its attendee list, reminders, and associated RSVP data.
DELETE Delete Event Resource /api/events/resources/{resourceid} Provides an automated mechanism for removing delete resource data from the system.
DELETE Delete Event Type /api/eventtypes/{eventtypeid} Provides an automated mechanism for removing delete event type data from the system.
DELETE Delete Reminder /api/events/{EventID}/reminders/{ReminderID} Delete a particular reminder for an event
DELETE Delete User from Event /api/events/{EventID}/users/members/{UserID} Provides an automated mechanism for removing delete event member user data from the system.
GET Get Attendance Stats /api/events/{EventID}/attendancestats Enables administrators and developers to programmatically retrieve event attendance statistics.
GET Get Calendar Events /api/calendars/events Get a list of space events or personal events
GET Get Event /api/events/{EventID} Retrieve the full details of a specific event by its ID, including its title, dates, location, description, and attendance information.
GET Get Event Attendees /api/events/{EventID}/attendees Enables administrators and developers to programmatically retrieve a list of event attendees by RSVP type.
GET Get Event Invitees /api/events/memberinvitees Enables administrators and developers to programmatically retrieve a list of users invited to an event who have not yet responded.
GET Get Event Resource /api/events/resources/{ResourceID} Enables administrators and developers to programmatically retrieve an event resource.
GET Get Event Resource Availability /api/events/resources/availability Check whether an event resource is available at a certain time.
GET Get Event Resource Types /api/events/resourcetypes Enables administrators and developers to programmatically retrieve a list of event resource types along with their resources.
GET Get Event Resources /api/events/resources Get a list of event resources
GET Get Event Type /api/eventtypes/{EventTypeID} Enables administrators and developers to programmatically retrieves event type information.
GET Get Event Types /api/events/types Enables administrators and developers to programmatically retrieve a list of event types in a space.
GET Get Events /api/events Retrieve a filtered list of events from the intranet calendar. Supports filtering by space, creator, date range, event type, and venue. Results can be sorted and paginated for large event collections.
GET Get Events by User ID /api/events/spaces/{SpaceID} Enables administrators and developers to programmatically retrieve a list of space events and check a specific user's attendance status.
GET Get Guest Attendees /api/events/guestattendees Enables administrators and developers to programmatically retrieve a list of external users for an event.
GET Get Guest Invitees /api/events/externalinvitees Enables administrators and developers to programmatically retrieve a list of external users invited to an event who have not yet responded.
GET Get My RSVP /api/events/{EventID}/rsvp/me/status Enables administrators and developers to programmatically retrieve the current user's RSVP for a particular event.
GET Get Reminders /api/events/{EventID}/reminders Enables administrators and developers to programmatically retrieve a list of reminders a user has set for a certain event.
GET Get User RSVP /api/events/{EventID}/rsvp/{UserID}/status Enables administrators and developers to programmatically retrieve a user's RSVP for a particular event.
PUT Invite Users to Event /api/events/{EventID}/invitees/members Technical reference for the Add Member Invitees endpoint, providing programmatic access to add member invitees functionality.
PUT Mark As Organizer /api/events/{EventID}/organizer Mark or unmark an event invitee or attendee as an organizer.
PUT Update Event /api/events/{eventid} Update an existing event on the intranet calendar. Supports modifying event details, location, recurrence settings, and visibility options.
PUT Update Event Type /api/eventtypes/{EventTypeID} Supports the synchronization and modification of update event type properties via the API.
PUT Update Event View Count /api/events/viewcount Supports the synchronization and modification of update event view count properties via the API.
PUT Update RSVP /api/events/{EventID}/rsvp/me/status Supports the synchronization and modification of update rsvpof logged in user properties via the API.

Wiki Index

Pages