360 Resource Manager: Using the License Data API
- Product: 360 Resource Manager
How do I use the 360 Resource Manager License Data API?
The Resource Manager License Data XML API is a SOAP web-service application program interface for the retrieval of a Client Center profile's license information. Information about profile resources (collections, databases, titles) associated with each of the profile's licenses are included in the retrieved license information.
You must have a current API License Data Terms of Use Non-Disclosure Agreement (NDA) on file with ProQuest. The 360 Services: XML APIs identifies and describes the operation of APIs and our services. Please use the Contact Us menu above to contact our Support team if you want to implement the License Data API at your library or institution.
Access and Authentication
A Client Center account with Licensing - View or Licensing - View/Edit permissions is required.
Requesting Data:
Base URL for requesting data is:
https://rmws.serialssolutions.com/serialssolutionswebservice/SerialsSolutions360WebService.asmx?op=LicenseData.
Base URL for requesting data is:
https://rmws.serialssolutions.com/serialssolutionswebservice/SerialsSolutions360WebService.asmx?op=LicenseData.
GET and POST are supported.
Data is requested by populating the SOAP request envelope with values for LibraryCode, UserName, and Password. Note there is no Version parameter and there are no filtering parameters. Thus, the request is for all license data for a profile.
Below is a sample SOAP request, for Client Center profile "NAN", user SomeBody@SomeLibrary.com, password "doodah"
Below is a sample SOAP request, for Client Center profile "NAN", user SomeBody@SomeLibrary.com, password "doodah"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<LicenseData xmlns="http://serialssolutions.com/">
<request>
<LibraryCode>NAN</LibraryCode>
<UserName>SomeBody@SomeLibrary.com</UserName>
<Password>doodah</Password>
</request>
</LicenseData>
</soap:Body>
</soap:Envelope>
XML Structure
Data returned: Data is returned in XML format. Data is restricted to the license information for the LibraryCode passed in the SOAP request. All license information for the LibraryCode is returned, along with all associated resources for each license. LicenseXMLApiSchema.xsd is the source XML Schema Definition document for the License XML API. See that file for complete definition of all data returned, with format information.
A Web Service Definition Language file is posted at https://rmws.serialssolutions.com/serialssolutionswebservice/SerialsSolutions360WebService.asmx?wsdl.
Output from this URL displays the complete structure of all data returned, with format information. The WSDL includes data for four top-level elements: DataExchange, DataExchangeResponse, LicenseData, and LicenseDataResponse. Elements DataExchange and DataExchangeResponse are not used by the License Data XML API. Element LicenseData is for requesting a response from the License Data XML API by supplying a LibraryCode, UserName, and Password. Element LicenseDataResponse is the returned data of the License Data XML API.
Data Content: See file License XML Api Field Relationships with Client Center Fields.xlsx for a mapping of each element of the XML API to Client Center data.
Parameters
There are no parameters for filtering or restricting data. The only parameters accepted in the request envelope are LibraryCode, UserName, and Password. Data returned is all license information for the Client Center profile specified by parameter LibraryCode. Filtering or restriction of data must be done by the consuming application.
Diagnostic Messages
A single diagnostic message is returned by the API. A SoapException of AccessDenied is returned. Two circumstances will return AccessDenied:
- LibraryCode/UserName/Password parameters are incorrect
- UserName does not have
Here is an example diagnostic error message:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>System.Web.Services.Protocols.SoapException: AccessDenied
at SerialsSolutions360WebService.SerialsSolutions360WebService.LicenseData(AuthenticationData request) in E:\_CSProjects\Application-2013.Q1\SersolWebService\SerialsSolutions360WebService.asmx.cs:line 202</faultstring>
<faultactor>http://d6p7wk1.devqa.sersol.il.pqe/C...ebService.asmx</faultactor>
<detail>
<WebServiceException>
<Message>AccessDenied</Message>
<Reason>Caller does not have permission to call this API</Reason>
</WebServiceException>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>System.Web.Services.Protocols.SoapException: AccessDenied
at SerialsSolutions360WebService.SerialsSolutions360WebService.LicenseData(AuthenticationData request) in E:\_CSProjects\Application-2013.Q1\SersolWebService\SerialsSolutions360WebService.asmx.cs:line 202</faultstring>
<faultactor>http://d6p7wk1.devqa.sersol.il.pqe/C...ebService.asmx</faultactor>
<detail>
<WebServiceException>
<Message>AccessDenied</Message>
<Reason>Caller does not have permission to call this API</Reason>
</WebServiceException>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>
Notes
Label and Content: Most data elements in the returned data have sub-elements of "Label" and "Content". The value of sub-element Label is the corresponding Client Center field name for the element. The value of sub-element Content is the actual value of the element. Hence, the value of Label will not change, but the value of Content will. Label is provided as a convenience to the data consumer so that the relationship of the element to Client Center data is more readily apparent. Resource sub-elements do not have Label and Content sub-elements.
- Date Created: 9-Feb-2014
- Last Edited Date: 3-Aug-2016
- Old Article Number: 7399