Blended Calendar View

Web Calendar View

Celcat Vendor

campusM uses the following Celcat APIs:

GET /api/students – The parameters and headers passed into this API are all set within the configuration page.

GET /api/events?studentId={{user_input_identifier}} – This returns the timetable data for the user.

Oracle PeopleSoft Vendor

The table below includes the relevant fields from PeopleSoft. Ensure that you are using the correct fields when building the query.

The Timetable query is prompted by  USER_ID, START, and END, and returns the class/course meeting information:

campusM uses the following API:

Get https://{URL for Timetable PeopleSoft Query} 

isconnectedquery=n 

maxrows=0

prompt_uniquepromptname=USER_ID,START,END

prompt_fieldvalue={example: ExampleStudentUsername,2020-04-06,2020-04-13} 

json_resp=true

The parameters and headers passed into this API are all set in the configuration page. Note that USER_ID, START, and END should be added to the configuration page as separate query parameters. The back end handles concatenating these together for prompt_uniquepromptname and generates the value for prompt_fieldvalue, which are the actual query parameters used in the request for PeopleSoft, as seen in the example above. The names used for USER_ID, START, and END are flexible, e.g.,USER_ID could be EMPLID instead, etc., but all other parameters are expected to be the exact names listed here, i.e., isconnectedquery, maxrows, and json_resp. The "Prompt Param" configuration field should only be checked true for USER_ID, START, and END. Another important thing to note is that query-parameter order matters, so you must have them in the correct order in the configuration. 

The response must use the following format. campusM expects the names of the row attributes to match those in this example. 

RESTful API Vendor

campusM expects the following RESTful API:

Example GET request: https://someHostName/serviceName/username?StartDate=[startdate]&EndDate=[enddate]

• JSON Expected Format
  {
      "events": [
          {
              "eventRef": "ref 1",
              "desc1": "Quantum mechanics exam 1",
              "desc2": "Exam Timetable",
              "desc3": "Some other description",
              "start": "2020-07-27T07:00:00.000Z",
              "end": "2020-07-27T07:00:00.000Z",
              "teacherName": "Faculty invigilator",
              "teacherEmail": "buckleym@example.ac.uk",
              "locCode": null,
              "locUrl": null,
              "locAdd1": "Great Hall",
              "locAdd2": "Senate building",
              "locAdd3": null,
              "locAdd4": null,
              "locPostCode": null,
              "locWorkTel": null,
              "attendanceExclude": false,
              "campus": "London",
              "meeting": true, 
              "meetingURL": "https://www.google.com/", 
              "meetingURLDesc": "This is a meeting url description" 
          }
• XML Expected Format
  <root>
    <events>
      <eventRef>ref 1</eventRef>
      <desc1>Quantum mechanics exam 1</desc1>
      <desc2>Exam Timetable</desc2>
      <desc3>Some other description</desc3>
      <start>2020-07-27T07:00:00.000Z</start>
      <end>2020-07-27T07:00:00.000Z</end>
      <teacherName>Faculty invigilator</teacherName>
      <teacherEmail>buckleym@example.ac.uk</teacherEmail>
      <locCode/>
      <locUrl/>
      <locAdd1>Great Hall</locAdd1>
      <locAdd2>Senate building</locAdd2>
      <locAdd3/>
      <locAdd4/>
      <locPostCode/>
      <locWorkTel/>
      <attendanceExclude>false</attendanceExclude>
      <campus>London</campus>
      <meeting>true</meeting>
      <meetingURL>https://www.google.com/</meetingURL>
      <meetingURLDesc>This is a meeting url description</meetingURLDesc>
    </events>
  </root>
• Attributes Mapping for JSON/XML Fields

  Attributes Mapping

  External Field Name	Internal CampusM Field Name	Description	Mandatory Yes/No	Data Type	Default	Example
  Event Reference	eventRef	A unique ID for the event	yes	String max 100 chars	-	"EVENT12345" eventRef should include only alphanumeric chars and  '.', '-', ':'
  Primary Description	desc1	The primary description of the Event/Course/Exam	yes	String	-	"Quantum mechanics exam 1"
  Secondary Description	desc2	The secondary description of the Event/Course/Exam	no	String - truncated after 2000 chars	-	"Exam Timetable"
  Tertiary Description	desc3	Tertiary description - Any additional details of the event type. It is displayed on the detail page of the calendar, below the primary description.	no	String - truncated after 2000 chars	-	-
  Start Date	start	The start date/time - the format for this is configurable in the configuration area.	yes	String	-	"2019-08-13T07:00:00.000Z"
  End Date	end	The end date/time. The format for this is configurable in the configuration area. (It does not have to contain the timezone information).	yes	String	-	"2019-08-13T07:00:00.000Z"
  Lecturer Name	teacherName	The name of the teacher	no	String	-
  Lecturer Email	teacherEmail	The email of the teacher - Clicking the email allows the user to send an email	no	String	-	"buckleym@example.ac.uk"
  Location Reference	locCode	Clicking the location links the user to campus maps. This must be a unique identifier for the location to which you want to link in campus maps. The data type can be any string, and must be set as the location reference for the position in the App Manager.	no	String	-
  Location Reference	locUrl	A URL that can be sent in the response. It can be a campusM URL scheme / standard HTTP link (overrides locCode as the location reference link)	no	String	-
  Location Name	locAdd1	A description of the location of the event	no	String	-	"Great Hall"
  Additional Location Information	locAdd2	An additional description of the location	no	String	-	"Senate building"
  Additional Location Information	locAdd3	An additional description of the location	no	String	-
  Additional Location Information	locAdd4	An additional description of the location	no	String	-
  Location Post Code	locPostCode	If this field is populated, the location name will be treated as the first line of an address rather than a room name	no	String	-
  Location Work Telephone Number	locWorkTel	Contact number of the event location or organizer	no	String	-
  Attendance Exclude Flag	attendanceExclude	A flag that defines whether or not to exclude the event from attendance monitoring. If this is not specified, all events have attendance monitoring enabled. Note that this is only relevant when campusM Attendance has been deployed.	no	Boolean (true/false)	false	true
  Campus Name	campus	If there are multiple campuses, this field can be used to distinguish between different timezones	no	String	-
  Meeting	meeting	A flag that indicates if a meeting link will be included	no	Boolean	false
  Meeting URL	meetingURL	The URL for the meeting for the event	no	String	-
  Meeting URL Description	meetingURLDesc	The description for the meeting URL	no	String	-

• iCal Expected Format:
  BEGIN:VCALENDAR
  BEGIN:VEVENT
  DTSTART:20200428T180000
  DTEND:20200428T210000
  CREATED:20200226T165202Z
  UID:8568585558096800-1588107600
  SUMMARY:Linear Algebra
  DESCRIPTION:This is a math course
  URL:https://www.hostName.edu/event/r-a-d-free-9-hour-womens-self-defense/2020-04-28/
  LOCATION:Hammond Peregrine Hall 300\, 2330 173rd Street\, Hammond\, IN\, 46323\, United States
  GEO:41.5805562;-87.4723704
  ORGANIZER;CN=John Smith:MAILTO:jsmith@host1.com
  X-MEETING:true
  X-MEETING-URL:https://google.com/
  X-MEETING-URL-DESC:This is a great description
  X-PROPERTY-LOCATION-WORK-PHONE:207-123-4567
  END:VEVENT
  END:VCALENDAR
• Attributes Mapping for iCal Fields

  Attributes Mapping

  External Field Name	Internal CampusM Field Name	Description	Mandatory Yes/No	Data Type	Default	Example
  SUMMARY	Primary Description, Event Reference	The primary description of the Event/Course/Exam. In addition, 'Events Reference' will consist of this field (together with few others).	yes	String	SUMMARY	Primary Description, Event Reference
  DESCRIPTION	Secondary Description, Event Reference	The secondary description of the Event/Course/Exam. In addition, 'Events Reference' will consist of this field (together with few others).	no	String - truncated after 2000 chars	DESCRIPTION	Secondary Description, Event Reference
  DTSTART	Start Date, Event Reference	The start date/time - the format for this is configurable in the configuration area. In addition, 'Events Reference' will consist of this field (together with few others).	yes	String - yyyymmddThhmmssZ	DTSTART	Start Date, Event Reference
  DTEND	End Date, Event Reference	The end date/time. The format for this is configurable in the configuration area. (It does not have to contain the timezone information). In addition, 'Events Reference' will consist of this field (together with few others).	yes	String - yyyymmddThhmmssZ	DTEND	End Date, Event Reference
  ORGANIZER	Lecturer Name	The name of the teacher	no	String	ORGANIZER	Lecturer Name
  ORGANIZER	Lecturer Email	The email of the teacher - Clicking the email allows the user to send an email	no	String	ORGANIZER	Lecturer Email
  URL	Location Reference	A URL that can be sent in the response. It can be a campusM URL scheme / standard HTTP link (overrides locCode as the location reference link)	no	String	URL	Location Reference
  GEO	Location Latitude and Location Longtitude	The latitude (before ';') and longtitude (after ';'') for the location coordinates	no	Decimal	GEO	Location Latitude and Location Longtitude
  LOCATION	Location Name	A description of the location of the event	no	String	-	"Great Hall"

• Error Handling

  If there is an error in the response because timetable data does not exist for the user, the response is the following:

  HTTP Status Code should be ‘404 Not Found’

  The response contains the following text: timetable_not_found

• iCal

  iCal is required according to the iCal standard format. Customized event attributes can be added as additional iCal properties in the iCal feed. For the additional properties’ required configuration, see the Configuration section.

Banner Vendor

campusM uses the following Banner APIs:

MyTimetable (Semestry) Vendor

Ellucian Colleague (Custom) Vendor

1. The Ellucian Colleague (custom) vendor configuration is retrieved with the calType in the request coming from the application.
2. The body is built with information from the user identifier and from the request (start+end dates).
3. The courses information is received.
4. Event items are created.

Ellucian Colleague (Web API) Vendor

Google Calendar Vendor

Currently, campusM supports Public Google Calendars. campusM uses the following Google Calendar APIs: 

GET https://www.googleapis.com/calendar/v3/calendars/events

Additional information on this endpoint can be found here.

Prerequisites to be completed by the customer:

• Steps that must occur in the Google Developer Console prior to setting up the Product Integration 
  • Navigate to the Google Developer Console
  • From the left menu, select Library
  • Search for calendar
  • Select Google Calendar API
  • Select ENABLE
  • Select + CREATE CREDENTIALS > API Key. The "API Key created" page appears.
  • Note the API key
  • Select CLOSE. The newly created credential appears under API Keys.
• Prerequisites for the Product Integration Configuration page:
  • Have the API Key from the steps above
  • Get the calendar ID
    • In the Google Calendar interface, from the left, locate My calendars or Other calendars
    • Hover over the calendar you need and select the settings icon. A menu appears.
    • Select Settings
    • Scroll to the Integrate calendar section until you see Calendar ID with the relevant value below 
    • Copy this value to the product integration configuration page 

Microsoft Graph API (Calendars)

You will first need to configure Microsoft Azure (Graph) for the Timetable Product Integration. See here for more information.

The list of roles provided by the Microsoft Graph API will be acquired by using the following Microsoft Graph API services:

• https://login.microsoftonline.com/{t...th2/v2.0/token (in order to generate the token that will be used in the second service)
• https://graph.microsoft.com/v1.0/use...eTime=END_TIME (in order to get the response  which contains the roles list from above) 

Databee Exams Manager Vendor

campusM uses the following Databee API:

GET/api/personaltt/?event={{eventid}}&unique={{studentID}} – The parameters and headers passed into this API are all set within the configuration page. This returns the timetable data for the user.

Getting Microsoft Calendar Event via campusM API with Sample GetTimetableMicrosoft Service Request

For example: