DAP4 Web Services - StartingPoint: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
No edit summary
Line 1: Line 1:
== Protocol Independence ==
== Protocol Independence ==


Line 33: Line 31:
:<font size="2"><code>baseURL</code></font>
:<font size="2"><code>baseURL</code></font>


== Dataset: The metadata ==
=== Dataset: The metadata ===


The Dataset response is an XML document containing a dap:Dataset object as it's root element. It contains the persistent [[DAP4: Data Model]] representation of the dataset held at the server. If a constraint expression has been successfully applied, the service will returned the constrained view of the dap:Dataset object. The constrained view may contain different data structures than the unconstrained view as the constraint may alter the reasonable representation of the data set.
The Dataset response is an XML document containing a dap:Dataset object as it's root element. It contains the persistent [[DAP4: Data Model]] representation of the dataset held at the server. If a constraint expression has been successfully applied, the service will returned the constrained view of the dap:Dataset object. The constrained view may contain different data structures than the unconstrained view as the constraint may alter the reasonable representation of the data set.
Line 47: Line 45:
:<font size="2"><code>baseURL + '.xml' + [?dap_constraint]</code></font>
:<font size="2"><code>baseURL + '.xml' + [?dap_constraint]</code></font>


== Data: The data response for the dataset. ==
=== Data: The data response for the dataset. ===


The standard URL for this response is:  
The standard URL for this response is:  
:<font size="2"><code>baseURL + '.dap' + [?dap_constraint]</code></font>
:<font size="2"><code>baseURL + '.dap' + [?dap_constraint]</code></font>


== Data + Checksum ==
=== Data + Checksum ===


The standard URL for this response is:  
The standard URL for this response is:  
:<font size="2"><code>baseURL + '.cdap' + [?dap_constraint]</code></font>
:<font size="2"><code>baseURL + '.cdap' + [?dap_constraint]</code></font>

Revision as of 18:03, 22 February 2012

Protocol Independence

Proposal: The DAP4 data model and it's persistent (over-the-wire) representations are transport protocol agnostic. All of the information required by the DAP must be present in the content of the DAP requests and responses. The DAP won't uniquely embed information required by the DAP into HTTP Headers or AMQP thingys, or other whatnot.

Discussion:

  1. Does this matter? Is it something to strive for? Is it a Must? Is this just noise??
  2. Can the clients really make a request that's protocol independent?
  3. Would we need to add new syntax server-side functions etc. to the protocol to enable this?

Overview

This page describes the various web services that a DAP4 server must provide. These are for the most part REST services and as such are stateless unless noted otherwise.

The services are all defined as a modification of the service (aka resource or base) URL. This base URL essentially becomes a prefix (and could even be seen as a namespace) for all of the services available for that data resource.

In practice these have traditionally been implemented over HTTP. However they could just as easily be pushed over a different protocol, as long as the usage of the URL components remain consistent.


Required Responses

Service URL

The base URL for a data set accessed through a DAP4 web server will return a service document that describes the various responses possible for that data set, including URLs that can be used to access those responses.

DAP Service Terminus


The standard URL for this response is:

baseURL

Dataset: The metadata

The Dataset response is an XML document containing a dap:Dataset object as it's root element. It contains the persistent DAP4: Data Model representation of the dataset held at the server. If a constraint expression has been successfully applied, the service will returned the constrained view of the dap:Dataset object. The constrained view may contain different data structures than the unconstrained view as the constraint may alter the reasonable representation of the data set.

Also: All dap:Attribute objects have been removed from constrained dap:Dataset objects.

More information on the Dataset response can be found on the DAP4: Dataset Response page.

More information on the syntax of DAP4 constraint expressions can be found on DAP4: Data Model page.


The standard URL for this response is:

baseURL + '.xml' + [?dap_constraint]

Data: The data response for the dataset.

The standard URL for this response is:

baseURL + '.dap' + [?dap_constraint]

Data + Checksum

The standard URL for this response is:

baseURL + '.cdap' + [?dap_constraint]