getEproductAsXML

General Purpose

SOAP web service returns a broad range of information about a certain e-product in Verde.

The information provided by this service is the same as the information returned by the getEproduct service.

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

  • e-Product
  • Acquisition
  • License
  • Access
  • 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:getEproductAsXML><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:getEproductAsXML></soapenv:Body></soapenv:Envelope>

Output XML Format

Description:

The returned value is a complex type – EProductInformationEntityImpl, 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:getEproductAsXMLResponse xmlns:ns1="http://eproduct.webservice.api.verde.exlibris.com" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
   <getEproductAsXMLReturn xsi:type="xsd:string">
    <ns:EProductInformationData xmlns:ns="http://com/exlibris/verde/api/webservice/data/eproduct/xml">
     <EProductData>
      <id>28266278</id>
      <workExpressionCode>CWE_1123332848710_538897</workExpressionCode>
      <instanceCode>TST</instanceCode>
      <sourceInstanceCode>CKB</sourceInstanceCode>
      <eproductCode>CEP_1137341001449_12985</eproductCode>
      <SFXID>1000000000131774</SFXID>
      <metaLibID xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <otherID xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <otherSource xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <updateTarget>SFX</updateTarget>
      <procurementStatus>APPROVED</procurementStatus>
      <procurementStatusUpdateDate>18-Sep-2007</procurementStatusUpdateDate>
      <eStatus xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <eStatusUpdatedate/><activityStatusDateTo/>
      <privateNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <activationFromDate/>
      <activationToDate/>
      <sponseringLibraryCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <sponseringLibraryName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <mainContact xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <upCode>CEP_1137339370092_56</upCode>
      <freeOrSubscription>SUBSCRIPTION</freeOrSubscription>
      <crossRefEnabled>false</crossRefEnabled>
      <automaticUpdate>false</automaticUpdate>
      <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"/>
      <suppress>false</suppress>
      <addedToPackage/>
      <removedFromPackage/>
      <isIndependent>false</isIndependent>
      <JKEY>9EC</JKEY>
      <titleKey xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <packageType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <SFXID2 xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <selectiveModeCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      <coverageText>2003-12 m. ago </coverageText>
     </EProductData>
     <LicensesData>
      <LicenseData>
       <instanceCode>TST</instanceCode>
       <licenseName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <typeCode>REGULAR</typeCode>
       <methodCode>CLICK_THROUGH</methodCode>
       <executionDate/>
       <endDate/>
       <statusCode>NEW</statusCode>
       <statusNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <licensor xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <licensorName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <originalLicensor xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <originalLicensorName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <licensee xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <licenseeName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <licensingAgent xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <licensingAgentName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <localLicenseNegotiator xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <localNegotiatorName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <deliveryRequirements xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <licenseURI xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <licenseURIType>URI</licenseURIType>
       <physicalLocation xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <fileLocation xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <vendorAdvancedNoticeVal>DAYS</vendorAdvancedNoticeVal>
       <noticePeriodCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <licensingNote 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"/>
       <replacedBy xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <replaces xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <linkedLicenseNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <renewallOrCancellationMethodNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <renewalDate/>
       <creatorFullName>TST administrator</creatorFullName>
       <modifierFullName>TST administrator</modifierFullName>
       <createdBy>27015702</createdBy>
       <updatedBy>27015702</updatedBy>
       <creationDate>23-Apr-2008</creationDate>
       <updateDateCenter/>
       <updateDateLocal>23-Apr-2008</updateDateLocal>
      </LicenseData>
     </LicensesData>
     <AdminData>
      <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"/>
     </AdminData>
     <AcquisitionsData/>
     <AccessesData>
      <AccessData>
       <id>54522454</id>
       <instanceCode>TST</instanceCode>
       <accessCode>ACC_1208954344280_3</accessCode>
       <eproductCode>CEP_1137341001449_12985</eproductCode>
       <eproductType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <accessStatus>ACTIVE</accessStatus>
       <accessInfoNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <domainNames xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <implAutMethod>EMPTY</implAutMethod>
       <alternateAutMethod>EMPTY</alternateAutMethod>
       <autMethodNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <IPAddressRegMethod xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <IPAddressRegInstruction xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
       <IPAddressGeneralNote xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      </AccessData>
     </AccessesData>
     <szInheritedAvailability>false</szInheritedAvailability>
    </ns:EProductInformationData>
   </getEproductAsXMLReturn>
  </ns1:getEproductAsXMLResponse>
</soapenv:Body>
</soapenv:Envelope>