getEproductSummaryAsXML

General Purpose

SOAP web service returns summarized information about a certain e-product in Verde..

The information provided by the returned XML is the same as in the getEproductSummary service.

Unlike the getEproductSummary service, this service does not return a structured response but rather a string-like argument containing an XML description of the summary.
The returned packet contains information about the following attributes:

  • e-Product
  • License
  • Admin

Input Parameters

All Verde SOAP services use the same input parameters.

The following input parameters are used for SOAP requests:

  • indexName – String – e-Products can be identified by one of four possible types of identifier:
    • SFX_OBJECT
    • SFX_TARGET
    • METALIB_ID
    • Verde_ID (e-Product code)
  • indexValue – String – The value of the identifier.
  • instance – String – Verde instance code
  • institute – String – Verde institute code, can be blank
  • username – String – Verde staff code
  • password – String – Verde staff password
  • filter – String – returns only if e-product is active or returns e-product regardless of its status. Possible values are:
  • active
  • all

Input XML Format

Description: The input parameters are used to build a SOAP request.

Example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns0="http://eproduct.webservice.api.verde.exlibris.com"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <ns0:getEproductSummaryAsXML>
   <indexName soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:string">Verde_ID</indexName>
   <indexValue soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:string">CEP_1137341001449_12985</indexValue>
   <instance soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:string">TST</instance>
   <instituation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:string" />
   <username soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:string">TST_administrator</username>
   <password soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:string">TST_administrator</password>
   <filter soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:string" />
  </ns0:getEproductSummaryAsXML>
</soapenv:Body>
</soapenv:Envelope>

Output XML Format

Description:

The returned value is a complex type – EProductInformationSummaryEntityImpl, converted to XML.

Example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:getEproductSummaryAsXMLResponse xmlns:ns1="http://eproduct.webservice.api.verde.exlibris.com" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <getEproductSummaryAsXMLReturn xsi:type="xsd:string">
   <ns:EProductInformationSummaryData xmlns:ns="http://com/exlibris/verde/api/webservice/data/eproduct/xml">
    <EProductSummaryData>
     <ActivityStatus xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <ActivityStatusNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <PublicNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </EProductSummaryData>
    <LicensesSummaryData><LicenseSummaryData>
     <PublicNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <AuthorizesUserDef xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <LocalSuthorizesUserDef>false</LocalSuthorizesUserDef>
     <CitationRequirementDetails xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <DigitalCopyCode>EMPTY</DigitalCopyCode>
     <DigitalCopy xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <DigitalCopyTermNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <PrintCopyCode>EMPTY</PrintCopyCode><PrintCopy xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <PrintCopyTermNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <ScholarySharingCode>EMPTY</ScholarySharingCode>
     <ScholarySharing xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <ScholarySharingNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <DistanceEducationCode>EMPTY</DistanceEducationCode>
     <DistanceEducation xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <DistanceEducationTermNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <CourseReservePrintCode>EMPTY</CourseReservePrintCode>
     <CourseReservePrint xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <CourseReserveTermNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <ElectronicLink xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <ElectronicLinkCode>EMPTY</ElectronicLinkCode>
     <ElectronicLinkTermNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <CoursePackPrintCode>EMPTY</CoursePackPrintCode>
     <CoursePackPrint xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <CoursePackElectronicCode>EMPTY</CoursePackElectronicCode>
     <CoursePackElectronic xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <CoursePackTermNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <RemoteAccessCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <RemoteAccess>Remote access</RemoteAccess>
     <WorkinTermUseNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <LocalUsePermission xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </LicenseSummaryData></LicensesSummaryData>
    <AdminSummaryData>
     <HardwareRequirementsPublic xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <SoftwareRequirementsPublic xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <MaintenanceWindowValue xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <ProviderSystemStatusURI xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <ProviderSystemStatusURIType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
     <UserDocumentation xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </AdminSummaryData>
   </ns:EProductInformationSummaryData>
  </getEproductSummaryAsXMLReturn>
  </ns1:getEproductSummaryAsXMLResponse>
  </soapenv:Body>
  </soapenv:Envelope>