Home → API Documentation → Events/Training Calendar → api/Calendar

2.1. api/Calendar

This API call will return all events/training available to display online.

You can return items that are in the Future or items in the Past based on the parameter EventTimeFrame supplied.

If the EventTimeFrame supplied is the Past, then the items returned are based on:
•    Display On Web in Rubi being ticked.
•    The Event Status not being Pending or Cancelled.
•    The event’s start date and time being in the past compared to the current date and time.

Parameters To Submit

If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values.

Parameter	Parameter Help	Parameter Data Type
uid	Logged in user’s uid.	Boolean
EventType*	An Event Type value can be supplied to filter return results otherwise "All".	String – Max 50 chars
EventTimeFrame*	Submit either "Future" or "Past".	String – Max 10 chars

 

Return Response

The API call will return the following fields of data.

Field	Field Help
eid	Event GUID.
EventName	Event name.
EventStatus	Status of the event.
EventMonthYear	Integer value of month and year of the event.
EventDay	Day of event in shorthand string format.
EventStartTime	Event start time.
EventEndTime	Event end time.
EventDescription	The main body of text detailing the event. The field is named “Long Desc” in Rubi and is located on the event record’s “Details” page.
EventLocationOrganisation	Name of organisation the event is held (if applicable).
EventLocation1	First line of the event address location.
EventLocation2	Second line of the event address location.
EventLocation3	Third line of the event address location.
EventLocation4	Fourth line of the event address location.
EventLocationCounty	County of the event address location.
EventLocationPostcode	Postcode of the event address location.
EventLocationCountry	Country of the event address location.
EventTheme	Theme of the event.
EventType	Type of the event.
EventSponsor	JSON stringified array of sponsors.
BookOnline	Whether the event is bookable. This relates to the “Book Online” field set in Rubi under the “Web” section.
PriceCurrency	Currency code.
MemberPrice	Price of the event set for Member users.
NonMemberPrice	Price of the event set for Non Member users.
EventImage	Image URL set for the event. Field labelled “Event Image” in Rubi under the “Web” section.