You are here

Events Listing

The events API returns data for events.

Endpoint URL

https://content.uiowa.edu/api/v1/views/events_api.json?display_id=events

Relative End Dates

There are three endpoints that will give you results based on an end date relative to the start date given. They are:

https://content.uiowa.edu/api/v1/views/events_api.json?display_id=week
https://content.uiowa.edu/api/v1/views/events_api.json?display_id=month
https://content.uiowa.edu/api/v1/views/events_api.json?display_id=threemonths
https://content.uiowa.edu/api/v1/views/events_api.json?display_id=year

If you do not specify a start/end date parameter, it will use the current date.

Example Format

Parameters

Querystring Description Accepts
filters[interests] General Interests Filter IDs, multiple comma separated
filters[types] Event types Filter IDs, multiple comma separated
filters[audiences] Audiences Filter IDs, multiple comma separated
filters[place] Defined place Place ID
filters[department] Unit Unit ID
filters[keywords] Keywords Filter IDs, multiple comma separated
filters[startdate][value][date] Start date MM-DD-YYYY, defaults to today
filters[enddate][value][date] End Date MM-DD-YYYY, defaults to today
items_per_page Number of items to include on each page 5,10,15,25,50,100
page Page number Defaults to 0

Attributes

Events are in an array under the events attribute. There is also a page attribute which contains the current page, items per page and total number of pages.

id   Unique place identifier
name   Name of the place
updated_at   Updated date and time
created_at   Create date and time
url   Website for event
urlname   Unique slug for URL
first_date   Date of first instance of event
last_date   Date of final instance of event
room_number   Room number for the event
location_name   Name of predefined location for event
venue_url   Website for predefined location
address   Street address
geo   Collection of geo information with the following attributes:
  latitude Latitude of place
  longitude Longitude of place
  street Street part of address
  city City part of address
  state State part of address
  country Country part of address
  zip Zip code part of address
description_text   Description with no HTML included
description   Description with HTML
media   Array of images for event with the following attributes for each image
  original_image Path to the original uploaded image
  thumbnail_image Path to 100x100 version of image
  medium_image  
  large_image  
  alt_text Alt text for image
  title_text Title text for image
contact_name   Name of event contact
contact_phone   Phone number of event contact
contact_email   Email address of event contact
filters   Collection of all filters for the event
canceled   Boolean for if the event is canceled
event_instances   Collection of all event instances, which have the following attributes
  start Start date and time for the instance
  end End date and time for the instance
  all_day Boolean for if the instance is an all day event