Calendar
Want to push your configured event information into your CMS? You can do that, and we offer 3 methods for getting it done.
What's available
iCal feed (recommended)
RSS feed
Direct API call
iCal, as a standard, allows us to convey the most pertinent event information in a compliant format. RSS wasn't really meant for calendar data but we have exposed a very limited set of event properties in that format. The richest and most comprehensive event data is available via direct API call - but not all CMS platforms make that easy to manage.
Configuration - Everyday Events
All of the information pushed into the calendar feeds is managed from the edit event screen.
Events > Setup > click on your event > click on Edit > scroll to Event Calendar
Of all the fields here, the calendar blurb is the most important. If you wish to further limit the period of time an event appears, you can set a display from/until pair - but this is rare. Leaving both blank ensures fewer surprises.
Calendar Topics are only sent via the direct API response at the current time. Calendar Topics are configured under Events > Categories.
Configuration - Signature Events
Because signature event data is sync'd with the plaform, there are two places you need to touch to adjust content and inclusion in the feed.
Anything event related: edit master event Inclusion in the feed: in platform admin, Events > Reports > Calendaring section > Event Calendar Feed to toggle show/hide
iCal
Accessible from Events > Reports > Calendaring.
SUMMARY
Event Name
LOCATION
Event Location Name
DESCRIPTION
Calendar Blurb
DTSTART
Event start date/time (UTC)
DTEND
Event end date/time (UTC)
RSS
Accessible from Events > Reports > Calendaring.
title
Event Name
link
Registration URL
description
Calendar Blurb
dc:date
Event start date/time (UTC)
Direct API
To invoke this you'll need an AlumnIQ API key with the calendar-only restriction. API keys expire annually so please mind the x-days-until-expiration response header.
GET /events/calendar Optional Arg: onOrAfter in yyyy-mm-dd format. If omitted, "now" is assumed.
Returns an array of objects with the following properties:
isSignature
0
1
eventId
numeric
'sig_XXX' format
masterEventId
null
numeric
eventXCode
externalEventId
externalMasterEventId
guid
guid
signature-XXXX format
name
name
mastereventname
ispublic
true/false
true/false
isregisterable
true/false
true/false
marketingurl
registrationLandingBackdrop
(temporarily blank)
calendarSpotlightImage
registrationurl
eventTimeZoneId
event time zone
master event time zone
dateTimeEventStartLocal
per event time zone
dateTimeEventStartCampus
per env time zone
dateTimeEventStartUTC
dateTimeEventEndLocal
per event time zone
dateTimeEventEndCampus
per env time zone
dateTimeEventEndUTC
dateTimeRegistrationStartLocal
per event time zone
dateTimeRegistrationStartCampus
per env time zone
dateTimeRegistrationStartUTC
dateTimeRegistrationEndLocal
per event time zone
dateTimeRegistrationEndCampus
per env time zone
dateTimeRegistrationEndUTC
dateTimeCreatedUTC
null
dateTimeClosedUTC
null
timeZoneFriendlyLong
blank
timeZoneFriendlyShort
blank
timeZoneOffset
blank
isDuringDST
blank
calendarBlurb
calendar blurb
calendar blurb
calendarSpotlightImage
(temporarily blank)
calendar spotlight image
dateTimeCalendarStartUTC
display after
null
dateTimeCalendarEndUTC
display until
null
locationName
event location name
null
locationCity
event location city
null
locationState
event location state
null
eventCategoryName
event category label
null
tags
array of strings
empty
taxonomy
array of calendar topic objects with type + title keys
array of calendar topic objects with type + title keys
Last updated