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
| Field | Type | Description |
|---|---|---|
| orgCode | xsd:int | Mandatory – Supplied by Ex Libris as part of the implementation |
| apiKey | xsd:string | Mandatory – Supplied by Ex Libris as part of the implementation |
| profileId | xsd:int | Mandatory – This integer can be seen in the URL when browsing to App Manager > App Settings > App Profiles and selecting the profile you wish to query against. eg: https://appmanager.ombiel.com/app-settings/CampusM/userappprofile/123456789/ : the profile ID for this profile would be ‘123456789’ |
| startDate | xsd:dateTime | Mandatory – Start Date (in UTC) of the data you want to retrieve |
| endDate | xsd:dateTime | Mandatory – 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 |
| emailAddress | xsd:string | Optional parameter – will just retrieve the logs data for a particular person ID that will be retrieved by this email address |
| resumptionToken | xsd:string | Optional 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
| Field | Type | Description |
|---|---|---|
| apiKey | xsd:string | Mandatory – Supplied by Ex Libris as part of the implementation |
Body Parameters
| Field | Type | Description |
|---|---|---|
| orgCode | xsd:int | Mandatory – Supplied by Ex Libris as part of the implementation |
| profileId | xsd:int | Mandatory – This integer can be seen in the URL when browsing to App Manager > App Settings > App Profiles and selecting the profile you wish to query against. eg: https://appmanager.ombiel.com/app-settings/CampusM/userappprofile/123456789/ : the profile ID for this profile would be ‘123456789’ |
| startDate | xsd:dateTime | Mandatory – Start Date (in UTC) of the data you want to retrieve |
| endDate | xsd:dateTime | Mandatory – 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 |
| emailAddress | xsd:string | Optional parameter – will just retrieve the logs data for a particular person ID that will be retrieved by this email address |
| resumptionToken | xsd:string | Optional 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.
| Field | Type | Description |
|---|---|---|
| rawData | logEntries | A list of the log entries for the requested person |
| 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.