Check In Report
This API service retrieves a report of students who have checked in.
GET Method
Resource URL
GET /campusm/v1/addons/checkInReport
URL Parameters
None
Query string Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| orgCode | xsd:int | Required | Supplied by Ex Libris as part of the implementation |
| startDate | xsd:dateTime | Required | Event start date (in UTC) of the data you want to retrieve * or when the fetchBy parameter is added to the request with CHECKIN, then this is that start date/time of the Check-in range as recorded in the cloud. |
| endDate | xsd:dateTime | Required | Event end date (in UTC) of the data you want to retrieve * or when the fetchBy parameter is added to the request with CHECKIN, then this is that end date/time of the Check-in range as recorded in the cloud. (the allowed date range is 7 days from the startDate) |
| eventReference | xsd:string | Optional | Customer supplied event reference from timetable service – typically some combination of start date and room number |
| emailAddress | xsd:string | Optional | Will just retrieve the attendance data for a particular email address which typically matches the email address stored in the University IdP/ LDAP |
| fetchBy | xsd:string | Optional | If this parameter is set as CHECKIN, then the start date, end date/time specified corresponds to the Check-in date range as recorded in the cloud |
| resumptionToken | xsd:string | Optional | Token used to return the next segment of rows from the service if the isFinished flag is false. The resumptionToken is sent in the response |
| apiKey | xsd:string | Optional | Supplied by Ex Libris as part of the implementation |
Body Parameters
None
Example
URL – https://api-eu.hosted.exlibrisgroup.com/campusm/v1/addons/checkInReport?apiKey=<ORG_API_KEY>&orgCode=<ORG_CODE>&startDate=2018-08-26T17:00:00Z&endDate=2018-09-02T23:00:00Z
POST Method
Resource URL
POST /campusm/v1/addons/checkInReport
URL Parameters
None
Query string Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| apiKey | xsd:string | Optional | For validation – enter the organization given API key |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| orgCode | xsd:int | Required | Supplied by Ex Libris as part of the implementation |
| startDate | xsd:dateTime | Required | Start Date (in UTC) of the data you want to retrieve |
| endDate | xsd:dateTime | Required | Event start date (in UTC) of the data you want to retrieve * or when the fetchBy parameter is added to the request with CHECKIN, then this is that start date/time of the Check-in range as recorded in the cloud. |
| eventReference | xsd:string | Optional | Event end date (in UTC) of the data you want to retrieve * or when the fetchBy parameter is added to the request with CHECKIN, then this is that end date/time of the Check-in range as recorded in the cloud. (the allowed date range is 7 days from the startDate) |
| emailAddress | xsd:string | Optional | Will just retrieve the attendance data for a particular email address which typically matches the email address stored in the University IdP/ LDAP |
| fetchBy | xsd:string | Optional | If this parameter is set as CHECKIN, then the start date, end date/time specified corresponds to the Check-in date range as recorded in the cloud |
| resumptionToken | xsd:string | Optional | Token used to return the next segment of rows from the service if the isFinished flag is false. The resumptionToken is sent in the response |
Enter the parameters as a raw text in the body of the request such as the following text and fill in the fields with actual data:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://campusm.gw.com/campusm">
<soapenv:Header/>
<soapenv:Body>
<cam:AttCheckInReportRequest>
<cam:orgCode></cam:orgCode>
<cam:startDate></cam:startDate>
<cam:endDate></cam:endDate>
<!--Optional:-->
<cam:eventReference></cam:eventReference>
<!--Optional:-->
<cam:emailAddress></cam:emailAddress>
<!--Optional:-->
<cam:resumptionToken></cam:resumptionToken>
</cam:AttCheckInReportRequest>
</soapenv:Body>
</soapenv:Envelope>Example
URL – https://api-eu.hosted.exlibrisgroup.com/campusm/v1/addons/checkInReport?apiKey=<ORG_API_KEY>
Body –
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://campusm.gw.com/campusm">
<soapenv:Header/>
<soapenv:Body>
<cam:AttCheckInReportRequest>
<cam:orgCode>1234</cam:orgCode>
<cam:startDate>2018-08-26T17:00:00Z</cam:startDate>
<cam:endDate>2018-09-02T23:00:00Z</cam:endDate>
<!--Optional:-->
<cam:eventReference></cam:eventReference>
<!--Optional:-->
<cam:emailAddress></cam:emailAddress>
<!--Optional:-->
<cam:resumptionToken></cam:resumptionToken>
</cam:AttCheckInReportRequest>
</soapenv:Body>
</soapenv:Envelope>Output
This service returns a list of CheckInReportItem object.
Description:
| Field | Type | Description |
|---|---|---|
| checkInEntry | CheckInReportItem | List of check in report item objects |
| resumptionToken | xsd:string | Token used to return the next segment of rows from the service if the isFinished flag is false |
| isFinished | xsd:boolean | Flag that identifies if there is further data to be returned by the service following the initial request |
Click here to view an example of the response.
Click here to view the xsd file.