Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Latest commit

 

History

History
471 lines (439 loc) · 10.5 KB

events_site_id.md

File metadata and controls

471 lines (439 loc) · 10.5 KB

Get Events for Site given id

GET /events/{site}/{id}.{format}

Description

This method returns a specific event's information given a site slug and the unique id

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1567 Enabled Yes
Service Name events Service ID 271
Information Steward Each individual site's data steward Data Type Database
Update Frequency Realtime Cache Time 0 seconds

Notes

  • This is a 'realtime' feed. An item will be available on the api the second its up using Webhooks
  • Any value can be null

Sources

Parameters

GET /events/{site}/{id}.{format}
Parameter Type Required Description
key filter yes Valid API key
site input yes Valid site slug from /resources/sites
id input yes Valid event id
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /events/{site}/{id}.{format}

Response

Field Name Type Value Description
id integer Unique event id
title string Event title
description string Event description
description_raw string Raw event description (includes HTML markup)
times list The event's times
start date ISO 8601 formatted start date
end date ISO 8601 formatted end date
start_day string Full name of day of week for start day
start_date date YYYY-MM-DD formatted start date
start_time date HH:MM:SS 24 formatted start time
end_day string Full name of day of week for end day
end_date string YYYY-MM-DD formatted end date
end_time string HH:MM:SS 24 formatted end time
cost string Cost of event
audience list Audience targeted by event
tags list Tags related to event
type list Type of event
website object The event's website for more information
title string Title of the link
url string URL of the link
host object The event's host
title string Title of the link
url string URL of the link
image object Image representing the event
id integer Unique id of image
file string Relative link to image file path in filename.{format}
alt string Image alternate text
mime string Image MIME type in "string/{format}"
size integer Image file size in bytes
width integer Image width in pixels
height integer Image height in pixels
url string Full link to image resource
location object Location of the event
id integer Unique id of location
name string Name of location
street string Street address of location
additional string Additional information regarding street address of location
city string Name of city
province string Name of province in two-letter short form
postal_code string Postal code "in L#L #L#" format
country string Full name of country
latitude number Event location latitude
longitude number Event location longitude
site_name string Full site name as from https://api.uwaterloo.ca/v2/resources/sites.{format}
site_id string Site slug as from https://api.uwaterloo.ca/v2/resources/sites.{format}
revision_id integer Unique id of revision of event
link string URL of event link
link_calendar string iCal feed of event
updated date ISO 8601 formatted updated date

Any value can be null

Output

JSON

{
  "meta":{
    "requests":492,
    "timestamp":1399702009,
    "status":200,
    "message":"Request successful",
    "method_id":1567,
    "method":{
      
    }
  },
  "data":{
    "id":1701,
    "title":"Waterloo Engineering 5, 10, 15, 20, 30, 35, 40, and 45 Alumni Reunion",
    "description":"This alumni reunion in 2014 is for the classes of 1969, 1974, 1979, 1984, 1994, 1999, 2004 and 2008. We hope that you will be able to attend your reunion to reconnect with your classmates, your professors, your Faculty, and your University.There are various events happening all weekend long including an open house, lectures, tours of campus, a football game and a brunch the following day, just to name a few.",
    "description_raw":"<p><img alt=\"Engineering yearbook and jacket\" class=\"image-sidebar-220px-wide image-right\" height=\"225\" src=\"\/engineering\/sites\/ca.engineering\/files\/styles\/sidebar-220px-wide\/public\/uploads\/images\/2012-5-45Reunion_1.jpg?itok=dVf-g3gA\" width=\"220\" \/>This alumni reunion in 2014 is for the classes of 1969, 1974, 1979, 1984, 1994, 1999, 2004 and 2008. We hope that you will be able to attend your reunion to reconnect with your classmates, your professors, your Faculty, and your University.<\/p>\n<p>There are various events happening all weekend long including an open house, lectures, tours of campus, a football game and a brunch the following day, just to name a few.<\/p>",
    "times":[
      {
        "start":"2014-09-27T04:00:00-04:00",
        "end":"2014-09-27T04:00:00-04:00",
        "start_day":"Saturday",
        "start_date":"2014-09-27",
        "start_time":"04:00:00",
        "end_day":"Saturday",
        "end_date":"2014-09-27",
        "end_time":"04:00:00"
      }
    ],
    "cost":null,
    "audience":[
      "Faculty",
      "Alumni"
    ],
    "tags":[
      
    ],
    "type":[
      "Reunion"
    ],
    "website":{
      "title":"More reunion information",
      "url":"http:\/\/uwaterloo.ca\/engineering\/alumni\/reunions\/5-10-15-20-30-35-40-and-45"
    },
    "host":{
      "title":"Waterloo Engineering Alumni Affairs",
      "url":"https:\/\/uwaterloo.ca\/engineering\/alumni-and-friends"
    },
    "image":{
      "id":1323,
      "file":"2012-5-45Reunion.jpg",
      "alt":"Engineering yearbook and jacket",
      "mime":"image\/jpeg",
      "size":1253260,
      "width":2764,
      "height":2824,
      "url":"https:\/\/uwaterloo.ca\/engineering\/sites\/ca.engineering\/files\/uploads\/images\/2012-5-45Reunion.jpg"
    },
    "location":{
      "id":90,
      "name":"University of Waterloo",
      "street":"200 University Avenue West",
      "additional":null,
      "city":"Waterloo",
      "province":"ON",
      "postal_code":"N2L 3G1",
      "country":"Canada",
      "latitude":null,
      "longitude":null
    },
    "site_name":"Engineering",
    "site_id":"engineering",
    "revision_id":14587,
    "link":"https:\/\/uwaterloo.ca\/engineering\/events\/waterloo-engineering-5-10-15-20-30-35-40-and-45-alumni",
    "link_calendar":"https:\/\/uwaterloo.ca\/engineering\/events\/ical\/1701\/calendar.ics",
    "updated":"2014-04-09T12:48:32-04:00"
  }
}