WITSML Application Programming Interface Overview

Version 1.4.0

This document contains the following sections:

• Introduction
• Server Schema Objects
• Schemas, XML documents, and Style sheets

Changes between versions 1.3.1 and 1.4.0 are defined in the Schema Change Detail and in the API specification documents. This overview is non-normative and is not part of the standard.

Introduction

The Wellsite Information Transfer Standard Markup Language (WITSML) is a standard for sending well site information in an XML document format between business partners. XML schemas are used to define the content of an XML document. The WITSML standard consists of specifications which will are versioned independently: Data Schema and Application Program Interface (API). This document provides an overview of the Application Program Interface. The use of the Data Schema is required but use of the API is optional.

The API specification defines interfaces that will be implemented by a WITSML server for supporting client/server access. The specification defines two interfaces: Store and Publish. The Store interface is the primary interface and it provides basic access of information such as Get, Update, Add and Delete. The Publish interface is primarily intended to provide the WITS functionality of streaming data as it is being acquired.

The following files are the Web Service Description Language (WSDL) files used to expose the STORE and PUBLISH interfaces to SOAP clients: WMLS.WSDL and WMLP.WSDL. Note that these files are unchanged since v1.2.

Server Schema Objects

The Capability of Client object provides a mechanism for a client application to inform the server of the capabilities of the client. For example, what Data Schema versions does the client support.

capPublisher

The Capability of Publisher object provides a mechanism for a publisher application to inform a client application the capabilities of the server. For example, to which objects can a client subscribe.

capServer

The Capability of Server object provides a mechanism for a server application to inform a client application the capabilities of the server. For example, which Data Schema objects does a server support.

capSubscriber

The Capability of Subscriber object provides a mechanism for a subscriber application to inform a publishing application the capabilities of the subscriber. For example, what Data Schema versions does the subscriber support.

subscription

The Capability of Subscription object provides a mechanism for a subscriber application to tell the publisher application what data is to be included in the subscription.

Schemas, XML documents, and Style sheets:

The API specification requires the following object schemas and component sub-schemas. Component schemas are XML schemas, but they do not represent complete objects.  A component schema may be included by more than one object schema. All component schemas are prefixed with (cs_). Each component schema file generally defines one "type" that has the same name as the file name. Schema file cs_dataTypes.xsd defines many simplistic data types that are referenced by elements and attributes in object schemas and component schemas. It is directly or indirectly included in all object schemas. Schema file cs_catalog.xsd defines all enumeration data types that are referenced by elements and attributes in object schemas and component schemas.

The following schemas represent the information content of parameters in the API interface. They do not represent Data Schema objects that can be queried using the API query mechanisms.

Capability of Client Schema

Capability of Publisher Schema

Capability of Server Schema

Capability of Subscriber Schema

Capability of Subscription Schema