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

ParameterTypeRequiredDescription
orgCodexsd:intRequiredSupplied by Ex Libris as part of the implementation
startDatexsd:dateTimeRequiredEvent 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.

endDatexsd:dateTimeRequiredEvent 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)

eventReferencexsd:stringOptionalCustomer supplied event reference from timetable service – typically some combination of start date and room number
emailAddressxsd:stringOptionalWill just retrieve the attendance data for a particular email address which typically matches the email address stored in the University IdP/ LDAP
fetchByxsd:stringOptionalIf 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
resumptionTokenxsd:stringOptionalToken used to return the next segment of rows from the service if the isFinished flag is false. The resumptionToken is sent in the response
apiKeyxsd:stringOptionalSupplied 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

ParameterTypeRequiredDescription
apiKeyxsd:stringOptionalFor validation – enter the organization given API key

Body Parameters

ParameterTypeRequiredDescription
orgCodexsd:intRequiredSupplied by Ex Libris as part of the implementation
startDatexsd:dateTimeRequiredStart Date (in UTC) of the data you want to retrieve
endDatexsd:dateTimeRequiredEvent 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.

eventReferencexsd:stringOptionalEvent 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)

emailAddressxsd:stringOptionalWill just retrieve the attendance data for a particular email address which typically matches the email address stored in the University IdP/ LDAP
fetchByxsd:stringOptionalIf 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
resumptionTokenxsd:stringOptionalToken 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:

FieldTypeDescription
checkInEntryCheckInReportItemList of check in report item objects
resumptionTokenxsd:stringToken used to return the next segment of rows from the service if the isFinished flag is false
isFinishedxsd:booleanFlag 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.