Single Event API

Returns information about a single event by passing the event's ID as the parameter argument.

Location

https://calendar.byu.edu/api/Event

Example: https://calendar.byu.edu/api/Event?id=832

Parameters

 Parameter
 Description
id
The id of the event.

 

Return Values

Name
Description
EventId
The unique ID for the event.
Title
Title of the event.
Description
Description of the event if there is one. Limited to 250 characters.
ShortDescription
Shorter description of the event. Limited to 75 characters.
IsFeatured
True if it's featured on the homepage. False if it isn't.
LowPrice
The low price of the event.
HighPrice
The high price of the event.
PriceDescription
Additional description for the price.
LocationName
Name of the event's location.
Latitude
Corresponds with google maps api latitude. This is no longer supported. This returns as empty.
Longitude
Corresponds with google maps api longitude. This is no longer supported. This returns as empty.
ImgUrl
Url associated with a thumbnail picture corresponding to the event.
StartDateTime
MM-dd-yyyy HH:mm:ss
EndDateTime
MM-dd-yyyy HH:mm:ss
AllDay
True if the event occurs all day. False if the event doesn't.
MoreInformationUrl
Url for a link to additional information page.
IsPublishedNotMainCalendar
True if it is on the BYU calendar. False if it isn't.
OccurrenceId
Unique id associated with each occurance. This will now always be the same as the event id.
CategoryId
The ID for the categories. This corresponds with category names that can be found in the Category ID's section of this document.
CategoryName
The corresponding category name.
FullUrl
Displays the full url to the event on calendar.byu.edu.
IsFree
True/False if marked free. Note: Some events don't have tickets at all.
TagsIds
Displays comma separated list of tag ids.
TagsNames
Displays comma separated list of tag names.
DeptsIds
Displays comma separated list of internal category ids. This will include parent ids as this field includes hierarchical category information.
DeptNames
Displays comma separated list of internal category names. This will include parent names as this field includes hierarchical category information.

 

Return Format

XML is returned by default, but the format can be specified explicitly in the URL.

XML Example

https://calendar.byu.edu/api/Event.xml?id=832

JSON Example

https://calendar.byu.edu/api/Event.json?id=832

Changes

This used to be available from the Events API. It has been split out into it's own API.

See Events API for full details on the changes.