API Docs

CheckInReportItem

Overview

Data Dictionary

Click here to download checkInReportItem.xsd

CheckInReportItem

Description:

FieldTypeDescription
orgCodexsd:stringcampusM Organisation that this check in refers to
personIdxsd:stringcampusM user reference number
locationRefxsd:stringCustomer supplied location reference - typically a combination of building name and room number
eventRefxsd:stringCustomer supplied event reference from timetable service - typically a combination of start date and room number
eventStartxsd:dateTimeTime in UTC that the event started
eventEndxsd:dateTimeTime in UTC that the event ended
eventDescxsd:stringTimetable event description as shown to the student
deviceCheckinTimexsd:dateTimeThe time on the device at the time of the check in (in UTC)
devicePrecisionMetresxsd:stringPrecision metres value that comes from the device
deviceCheckinQueuedxsd:booleanWhether the check in was queued - if the device has no internet connection at the time, the check in will be uploaded at a later time when the device does have access. Possible values are: true or false
deviceCheckinLatitudexsd:stringdevice Latitude
deviceCheckinLongitudexsd:stringdevice Longitude
checkedInByxsd:stringWhere a lecturer checks a student in, their (lecturers) email address is recorded here - usually derived from the customer authentication service
ipAddressxsd:stringIp address of the device
userEmailxsd:stringEmail address of the user
devicePlatformxsd:stringCan be one of: IOS/Android/Web - the type of device used to do the check in
firstNamexsd:stringFirst name as recorded by the app - usually derived from the customer authentication service
lastNamexsd:stringSurname as recorded by the app - usually derived from the customer authentication service
checkinStatusxsd:stringWhether the check in action passed server validation. Possible values are: 'validated' (on success), 'invalid' (on failure), 'unvalidated' (could not validate)
checkinTypexsd:stringIndicates whether a check-in was completed by the student (SELF) or the lecturer (LECTURER)
otcxsd:stringOne time code used for validation
dateRecordedxsd:dateTimeThe time the check in event was received by the server
validationTypesValidationTypeArray of student check in validations results using the following fields:
Type: Otc/Gps
Status: Validated
validationText : Explanation of validation calculation

 

ValidationType

Description:

FieldTypeDescription
typexsd:stringType of the check in validation. Possible values are: 'OTC', 'GPS'
statusxsd:stringStatus of the check in validation
validationTextxsd:stringMessage of the result of the check in validaiton

 

Samples

XML
JSON
__