getEproductSummary

General Purpose

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

The returned value is a complex type – EProductInformationSummaryEntityImpl, described in the WSDL.

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, described in the WSDL available at:

http://<host_name>:<port_prefix>8080/verde/soap/services/Eproduct?wsdl

Example (Envelope only, object is inside):

<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:getEproductSummaryResponse xmlns:ns1="http://eproduct.webservice.api.verde.exlibris.com" soapenv:encodingStyle="*">" rel="nofollow"linktype="raw" linktext=">
  <getEproductSummaryReturn href="*#id0*" />
  </ns1:getEproductSummaryResponse>
  </soapenv:Body>
</soapenv:Envelope>