Events (Planner)
Product Information
Category | Other |
Sub-category | |
Website | |
Product version | |
Documentation | |
API Documentation |
About Events (Planner)
Institutions using campusM are able to present the full agenda to their targeted user group (by profile and role) and allow them to create their own custom schedule, saved and stored on their device.
Integration Overview
- Allow users to view the available locations as defined by the institution (if available)
- Once a location has been selected the user will be able to view the available dates for the selected location (if available)
- Once a date has been selected the user will be able to view the available events for that location and date with display information as configured by the institution
- The user will also be able to:
- Search for events by keywords
- Filter by institution provided tags
- When clicking on an event the user will be able to view the event information details as defined by the institution
- From within the full event page, users are able to save the event to their calendar as well as set a notification reminder
- Users are also able to view their saved schedule in a separate folder
- User email
- Event id
Integration Method
- XML
- JSON
- CSV (requires Connect Layer)
Prerequisites
Prerequisite | Additional Information |
---|---|
Data feed standard | Supported formats: XML, JSON or CSV |
Data feed end point | Required to be web accessible |
Web service end point for saved events | OPTIONAL |
User Experience
Property | Static Tile | Live Tile |
---|---|---|
Default Size | 1x1 | 1x2 |
Minimum Size | 1x1 | 1x2 |
Suggested Design |
Screenshots
Sample Requests
Sample Request |
---|
To be provided by the institution. Please see prerequisites.
|
Field Order | Field Name | Description | Mandatory |
---|---|---|---|
1 | Unique ID | The event unique identifier | Yes |
2 | Location |
Event location (simple text).
Events can be grouped to allow the user to first select a location. This can be useful for events in different campuses.
In case no values are provided, the location selection option will not be displayed to the user |
No |
3 | Date |
Event date (simple text).
Events can also be grouped by date to allow the user to select a date. This can be useful for events taking place across several days.
The date selection option will be provided in two scenarios:
In case no values are provided, the date selection option will not be displayed to the user
|
No |
4 | Start Date | Event start time (simple text). | Yes |
5 | End Date | Event end time (simple text) | No |
6 | Title | Event name (simple text) | Yes |
7 | Description | Event description (simple text) | No |
8 | External URL |
External webpage for the event (URL).
This allows the institution to send users to an external page with further event information
|
No |
9 | Location Code |
A campusM location code (Number).
This allows institutions to send users to the campusM maps for the event location
|
No |
10 | Search Tags |
Event search tags (CSV).
Categories or search tags to allow the users to filter by.
|
No |
Sample Response (CSV) |
---|
Unique ID,Location,Date,Start Time,End Time,Title,Description,External URL,Location Code,Search Code,Type,Requirements,Faculty 100001,Science Hall,12-Jul-2018,9:00am,10:30am,Orientation,This is an orientation day for new employees in the Boston office. Other employees are required to stay away from the office at that day,http://www.bostonoffice.com/orientation,10002843,"New Employees,Science",Mandatory,Employment certification,Science 100043,Science Hall,12-Jul-2018,10:45am,12:00pm,Introductions to Science,The new science introduction class is filled with exciting ideas,http://www.bostonoffice.com/orientat...3,Science,Open Session,,Science |
Sample Response (JSON) |
---|
[ { "Unique ID":100001, "Location":"Science Hall", "Date":"12-Jul-2018", "Start Time":"9:00am", "End Time":"10:30am", "Title":"Orientation", "Description":"This is an orientation day for new employees in the Boston office. Other employees are required to stay away from the office at that day", "External URL":"http://www.bostonoffice.com/orientation", "Location Code":10002843, "Search Code":"New Employees,Science", "Type":"Mandatory", "Requirements":"Employment certification", "Faculty":"Science" }, { "Unique ID":100043, "Location":"Science Hall", "Date":"12-Jul-2018", "Start Time":"10:45am", "End Time":"12:00pm", "Title":"Introductions to Science", "Description":"The new science introduction class is filled with exciting ideas", "External URL":"http://www.bostonoffice.com/orientation", "Location Code":10002843, "Search Code":"Science", "Type":"Open Session", "Requirements":"", "Faculty":"Science" } ] |
Sample Response (XML) |
---|
<?xml version="1.0" encoding="UTF-8"?> <events> <event> <Unique ID>100001</Unique ID> <Location>Science Hall</Location> <Date>12-Jul-2018</Date> <Start Time>9:00am</Start Time> <End Time>10:30am</End Time> <Title>Orientation</Title> <Description>This is an orientation day for new employees in the Boston office. Other employees are required to stay away from the office at that day</Description> <External URL>http://www.bostonoffice.com/orientation</External URL> <Location Code>10002843</Location Code> <Search Code>New Employees,Science</Search Code> <Type>Mandatory</Type> <Requirements>Employment certification</Requirements> <Faculty>Science</Faculty> </event> <event> <Unique ID>100043</Unique ID> <Location>Science Hall</Location> <Date>12-Jul-2018</Date> <Start Time>10:45am</Start Time> <End Time>12:00pm</End Time> <Title>Introductions to Science</Title> <Description>The new science introduction class is filled with exciting ideas</Description> <External URL>http://www.bostonoffice.com/orientation</External URL> <Location Code>10002843</Location Code> <Search Code>Science</Search Code> <Type>Open Session</Type> <Requirements></Requirements> <Faculty>Science</Faculty> </event> <events> |
In addition, campusM can send the institution a web service call whenever a user has saved an event.
Sample Request |
---|
{ |
Offline Functionality
Configuration Options
Configuration Item | Options | Default Value |
---|---|---|
Show My Events |
|
Yes |
Notification reminder time |
|
15 minutes |
Search result fields | Any data feed field |
Title Start time – end time |
Full page display fields | Any data feed field |
Title Date Start time End time Description |
Labels
Label | Default Value |
---|---|
Tile name | Events |
Search tab | Search |
Saved events tab | My Events |
Events page title | Search for events |
Saved events page title | My Events |
Suggested Testing Guidelines
- User can open the tile and view available locations, dates and events
- User can search by event keywords
- User can filter by institution provided tags
- User can view event full details
- User can save events to their personal schedule (stored on the device only)
- User can remove events from their personal schedule