Add or Modify Attendance Check-in Records
This API service provides the ability to add or edit an attendance check-in record to the system.
POST Method
Resource URL
POST /cmrest/admin/products/attendance/{orgCode}/addValidCheckInStudent
URL Parameters
| Parameter | Type | Required | Description |
| org_code | string | Required | The organisation code as specified in the app configuration in the settings page of app manager |
Query string Parameters
| Parameter | Type | Required | Description |
| apiKey | string | Required | Supplied by Ex Libris as part of the implementation |
| override | boolean | Optional | override boolean Optional If the check-in should override an existing check-in record |
Body Parameters
| Parameter | Type | Required | Description |
| orgCode | Integer | Optional | Supplied by Ex Libris as part of the implementation |
| userEmail | String | Required | Students’ email address for the check-in record |
| event Ref | String | Required | Event Ref for the event record |
| eventStart | Date | Optional | Event start time |
| eventEnd | Date | Optional | Event end time |
| deviceCheckinTime | Date | Optional | Used to provide check-in time stamp for alt check-in method |
| checkedInBy | String | Required | An identifier for the API for auditing |
| checkinStatus | String
| Required | Possible values are: ‘validated’ (on success), ‘invalid’ (on failure), ‘unvalidated’ (could not validate), ‘studentAbsent’ (student absence check-in, if enabled), ‘lecturerAbsent’ (lecturer absence check-in, if enabled) |
Enter the parameters as raw text in the body of the request:
{
"orgCode": <orgCode>,
"userEmail": <userEmail>,
"eventRef": <eventRef>,
"eventStart": <eventStart>,
"eventEnd": <eventEnd>,
"deviceCheckinTime": <deviceCheckinTime>,
"checkedInBy": <checkedInBy>,
"checkinStatus ": <checkinStatus>
}Example
URL –
https://api-eu.hosted.exlibrisgroup.com/campusm/ cmrest/admin/products/attendance/{orgCode}/addValidCheckInStudent?apiKey=<API KEY>
Body –
{
"userEmail": "user@gmail.com",
"eventRef": "5b20ff42cd088",
"eventStart": "2022-06-13",
"eventEnd": "2022-06-20",
"deviceCheckinTime": "2022-06-26T13:34:00.000",
"checkedInBy": "lecturer@rolesdemo.com",
"checkinStatus ": "validated"
}
Output
The service returns a success message or an error message in case of failure.
Example
{
"success": true,
"message": "Saved check in successfully"
}