Ready to Learn?Ex Libris products all provide open APIs

Insight Export Data

This API service retrieves an insight of the log entries for a specific user.
 

GET Method

Resource URL
GET /​campusm/​v1/​addons/​insightExportData
URL Parameters
None
Query string Parameters
FieldTypeDescription
orgCodexsd:intMandatory - Supplied by Ex Libris as part of the implementation
apiKeyxsd:stringMandatory - Supplied by Ex Libris as part of the implementation
profileIdxsd:intMandatory - default is ALL
startDatexsd:dateTimeMandatory - Start Date (in UTC) of the data you want to retrieve
endDatexsd:dateTimeMandatory - End Date (in UTC) of the data you want to retrieve
(the allowed date range is 30 days from the startDate), the default is last 24 hours
emailAddressxsd:stringOptional parameter - will just retrieve the logs data for a particular person ID that will be retrieved by this email address
resumptionTokenxsd:stringOptional parameter - 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
Body Parameters
 
None
 
Example
URL -  https://api-eu.hosted.exlibrisgroup.com/campusm/v1/addons/insightExportData?apiKey=<ORG_API_KEY>&orgCode=<ORG_CODE>&startDate=2018-08-26T17:00:00Z&endDate=2018-09-02T23:00:00Z&profileId=123

 

​POST Method

Resource URL
POST /​campusm/​v1/​addons/​insightExportData
URL Parameters
None
Query string Parameters
FieldTypeDescription
apiKeyxsd:stringMandatory - Supplied by Ex Libris as part of the implementation
 
Body Parameters
 
FieldTypeDescription
orgCodexsd:intMandatory - Supplied by Ex Libris as part of the implementation
profileIdxsd:intMandatory - default is ALL
startDatexsd:dateTimeMandatory - Start Date (in UTC) of the data you want to retrieve
endDatexsd:dateTimeMandatory - End Date (in UTC) of the data you want to retrieve
(the allowed date range is 30 days from the startDate), the default is last 24 hours
emailAddressxsd:stringOptional parameter - will just retrieve the logs data for a particular person ID that will be retrieved by this email address
resumptionTokenxsd:stringOptional parameter - 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:insightExportDataRequest>
         <cam:orgCode></cam:orgCode>
         <cam:apiKey></cam:apiKey>
         <cam:profileId></cam:profileId>
         <!--Optional:-->
         <cam:startDate></cam:startDate>
         <!--Optional:-->
         <cam:endDate></cam:endDate>
         <!--Optional:-->
         <cam:emailAddress></cam:emailAddress>
         <!--Optional:-->
         <cam:resumptionToken></cam:resumptionToken>
      </cam:insightExportDataRequest>
   </soapenv:Body>
</soapenv:Envelope>
 
Example:
URL -  https://api-eu.hosted.exlibrisgroup.com/campusm/v1/addons/insightExportData?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:insightExportDataRequest>
         <cam:orgCode>1234</cam:orgCode>
         <cam:apiKey></cam:apiKey>
         <cam:profileId>123</cam:profileId>
         <!--Optional:-->
         <cam:startDate>2018-10-01T00:00:00Z</cam:startDate>
         <!--Optional:-->
         <cam:endDate>2018-10-29T00:00:00Z</cam:endDate>
         <!--Optional:-->
         <cam:emailAddress></cam:emailAddress>
         <!--Optional:-->
         <cam:resumptionToken></cam:resumptionToken>
      </cam:insightExportDataRequest>
   </soapenv:Body>
</soapenv:Envelope>
Note: You can leave the apiKey in the body empty and only send it as a string parameter.
 
Output
This service returns a list of logEntries object.
 
FieldTypeDescription
rawDatalogEntriesA list of the log entries for the requested person
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.