Activities API

The Activities API provides academic section meetings and room assignment information for a specified date range. This data can be consumed by third-party applications then utilized in valuable ways for that application's use cases. Some example use cases are; digital signage and events calendaring. 

For each activity within the specified date range, the API returns:

When Where What
Start date / time
End date / time
Time zone
Room name
Room ID
Activity title
Activity ID

Note: This API will continue to be enhanced with more fields.

Endpoint

https://tn3dz47ox6.execute-api.us-east-1.amazonaws.com/v1-prod/activities

REST Verb

GET

Query Parameters

startDate –

  • Defines the beginning of the date range of activities to retrieve
  • Format: YYYY-MM-DD

endDate –

  • Defines the end of the date range of activities to retrieve
  • Format: YYYY-MM-DD

roomId (optional) -

  • Specifies the room in which the retrieved activities are scheduled
  • Format: case sensitive string

Query Example

https://kr1r51itec.execute-api.us-east-1.amazonaws.com/v0-prod/activities?startDate=2022-09-22&endDate=2022-09-29

Results Example

[

{
        title: 'NURS_234_Nsg Concepts Hlth & Illness II',
        startDateTime: '2022-09-01T06:30:00.000Z',
        endDateTime: '2022-09-01T18:29:00.000Z',
        roomName: 'HOSP1 HOSP',
        roomId: 'HOSP1_HOSP_200502',
        activityId: '202202_20339_131800_2022-09-01'
}

]

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.