Version and namespaces for the Data Ingest Web Service

This topic describes the version of the Data Ingest Web Service and two namespaces used for data ingest operations.

XML namespaces provide a method for qualifying element and attribute names used in Extensible Markup Language documents by associating them with namespaces identified by URI references. The Data Ingest Web Service uses two namespaces.

Data Ingest Web Service version and namespace

The namespace for the Data Ingest Web Service (DIWS) is:
http://www.endeca.com/MDEX/ingest/1/0
This namespace reflects the version of the Data Ingest Web Service. This namespace is included in the WSDL document for the web service.

In this example, the string 1/0 indicates the version as 1.0, where 1 is the major version, and 0 is the minor version. Note that the version in the service that you have installed may not match this example.

Changes to minor versions are backward-compatible. If any backward-compatible versions exist, additional namespaces are included in the WSDL, listing them. You can use any backward-compatible minor version that is listed. For example, if both 1.0 and 1.1 versions are listed in the WSDL, you can use either of them.

Changes to major versions are not backward-compatible, thus previous major versions are not listed in the WSDL namespaces.

Important: After you upgrade the Oracle Endeca Server, verify the versions of the web services you have been using against the installed versions, to avoid version mismatch. It is recommended to use the web service versions that match the ones installed with the Oracle Endeca Server.
In particular:
  • If the minor version of the web service on your client does not match the version installed with the Oracle Endeca Server, you can still use this version if it is listed in the WSDL namespaces, although it is recommended to upgrade.
  • If the major version of the web service on your client does not match the version of the web service installed with the Oracle Endeca Server, you must upgrade to the most recent major version of the web service (this may include upgrading client code to use client stubs generated from the most recent versions).

For more information on web service versions, see the Oracle Endeca Server Developer's Guide.

The xmlns attribute specifies this namespace for a DIWS prefix for a document, as in this example, also showing the version:
<ingest:ingestRecords 
   xmlns:ingest="http://www.endeca.com/MDEX/ingest/1/0" 
   ...
   <ingest:addAssignments>
      ...
   </ingest:addAssignments>
</ingest:ingestRecords>

After this declaration, all DIWS elements will use the same prefix, which will be associated with the same namespace. In the example, the prefix ingest is defined for all DIWS elements, such as the ingest:addAssignments element.

You can use a prefix of your own choosing, but it must be bound to the DIWS namespace listed above. In this guide, the prefix ingest will be used in the examples.

mdex element namespace

The namespace for mdex elements is:
http://www.endeca.com/MDEX/XQuery/2009/09

The important mdex elements used in data ingesting are mdex:record for records and the nine property types, such as the mdex:string property type.

You must also use the xmlns attribute to set the mdex namespace in your XML documents:
<ingest:ingestRecords 
      xmlns:ingest="http://www.endeca.com/MDEX/ingest/1/0" 
      xmlns:mdex="http://www.endeca.com/MDEX/XQuery/2009/09">
   <ingest:addAssignments>
      <mdex:record>
         <FactSalesID>683</FactSalesID>
         <Price type="mdex:double">59.99</Price>
         <NumInStock type="mdex:int">68</NumInStock>
         <Description type="mdex:string">Road gloves</Description>
      </mdex:record>
   </ingest:addAssignments>
</ingest:ingestRecords>