alpha-version-dce-check-in-api/src/shared/types/AttendanceEntry.ts

API for taking attendance and checking people in.

// Import shared types
import AttendanceMethod from './AttendanceMethod';

/**
 * Information needed to log attendance.
 * @author Benedikt Arnarsson
 * @author Gabe Abrams
 */
type AttendanceEntry = {
  // User Canvas Id
  userId: number,
  // TODO: discuss how we are getting the user's name
  // User's name
  userFirstName: string,
  // User's name
  userLastName: string,
  // Course Canvas Id
  courseId: number,
  // IHID of the event attended
  ihid: string,
  // Method of attendance
  method: AttendanceMethod,
  // Optional. Group number
  groupNum?: number,
  // True if user is a student
  isLearner?: boolean,
  // True if user is an admin
  isAdmin?: boolean,
  // True if the user is a host
  isHost?: boolean,
  // ms since epoch TIME OF EVENT (if in the past and known)
  eventTimestamp?: number,
};

export default AttendanceEntry;