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

2.2. api/CalendarDetail

This API call will return details about a specific event. To retrieve details about a specific event you must pass in the eid acquired from api/Calendar.

Parameters To Submit

Parameters can be submitted as blank values.

Parameter	Parameter Help	Parameter Data Type
uid	Logged in user’s uid.	String – Max 50 chars
eid	The event eid to return more information on.	String – Max 50 chars

 

Return Response

The API call ResponseMessage 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.
EventDate	Date of the event in format dd/mm/yyyy.
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.
EventPresenters	JSON stringified array of presenters.
BookOnline	Whether the event is bookable. This relates to the “Book Online” field set in Rubi under the “Web” section.
AllowWaitlist	Whether the event has a waitlist if the “MaxRemaining” is 0 noting no more spaces on the event. This relates to the “Allow Waitlist” field set in Rubi under the “Web” section.
PriceCurrency	Currency code.
MemberPrice	Price of the event set for Member users.
MemberPriceSpecial	Price of event set for Member users if a special rate (early bird) has been applied. The special rate should be valid until “MemberPriceSpecialDate” has passed.
MemberPriceSpecialDate	Date the till “MemberPriceSpecial” is valid.
NonMemberPrice	Price of the event set for Non Member users.
NonMemberPriceSpecial	Price of event set for Non Member users if a special rate (early bird) has been applied. The special rate should be valid until “NonMemberPriceSpecialDate” has passed.
NonMemberPriceSpecialDate	Date the till “NonMemberPriceSpecial” is valid.
EventImage	Image URL set for the event. Field labelled “Event Image” in Rubi under the “Web” section.
MaxCompany	The maximum amount of bookings allowed per company. Used to minimise company numbers for networking events.
MaxCompanyRemaining	The remaining number of bookings allowed for a company after taking into account active bookings and bookings awaiting payment. Provided a uid is supplied.
MaxRemaining	Total number of bookings available as a whole for the event. Takes into account active bookings.
CompanyWaitlist	Returns the total number of bookings that are on the waitlist for the company. Provided a uid is supplied.
CompanyActive	Returns the total number of active bookings for the company. Provided a uid is supplied.
CompanyWebAwaitingPayment	Returns the total number of bookings awaiting payment for the company. Provided a uid is supplied.
CanxPol	Cancellation policy for the event. Only to be used if the cancellation policy differs from the standard. If empty then use standard cancellation policy.
Agenda	Agenda for the event. The field named “Agenda” in Rubi and is located on the event’s “Details” page.
IsMember	Whether the user is a member or not. Provided a uid is supplied.