DAP4 Web Services v3 - Revision history

Ndp at 21:47, 13 November 2013

2013-11-13T21:47:45Z

← Older revision		Revision as of 21:47, 13 November 2013
Line 2:		Line 2:
	[[OPULS_Development\| << Back to OPULS Development]]		[[OPULS_Development\| << Back to OPULS Development]]

	<font size="+1" color="red">This is an old document that captures an intermediate point of the OPULS design work. ~~It's out of date and~~ should be referenced only as part of a baseline for the work. It has been superseded by the ''[[DAP4: Specification Volume 2 \| DAP4 Specification Volume 2: Web Services Specification]]'' </font>		<font size="+2" color="red"> This page is out of date and will not be updated. This is an old document that captures an intermediate point of the OPULS design work. This page should be referenced only as part of a baseline for the work. It has been superseded by the ''[[DAP4: Specification Volume 2 \| DAP4 Specification Volume 2: Web Services Specification]]'' </font>

	== Introduction ==		== Introduction ==

Ndp at 21:44, 13 November 2013

2013-11-13T21:44:49Z

← Older revision		Revision as of 21:44, 13 November 2013
Line 1:		Line 1:
	[[Category:Development\|Development]][[Category:DAP4\|DAP4]]		[[Category:Development\|Development]][[Category:DAP4\|DAP4]]
	[[OPULS_Development\| << Back to OPULS Development]]		[[OPULS_Development\| << Back to OPULS Development]]

			<font size="+1" color="red">This is an old document that captures an intermediate point of the OPULS design work. It's out of date and should be referenced only as part of a baseline for the work. It has been superseded by the ''[[DAP4: Specification Volume 2 \| DAP4 Specification Volume 2: Web Services Specification]]'' </font>

	== Introduction ==		== Introduction ==

Ndp: /* Normative Encoding of the Asynchronous Response */

2013-11-07T03:54:49Z

Normative Encoding of the Asynchronous Response

← Older revision		Revision as of 03:54, 7 November 2013
Line 668:		Line 668:
	==== Normative Encoding of the Asynchronous Response ====		==== Normative Encoding of the Asynchronous Response ====

	The normative XML representation for the ~~Error~~ Response is defined in Appendix x "Normative XML Encoding of the ~~Error~~ Response". The media type for the normative XML representation is:		The normative XML representation for the Asynchronous Response is defined in Appendix x "Normative XML Encoding of the Asynchronous Response". The media type for the normative XML representation is:

	: <font size="2"><code>'''application/vnd.org.opendap.dap4.async.xml'''</code></font>		: <font size="2"><code>'''application/vnd.org.opendap.dap4.async.xml'''</code></font>


	=== DAP4 Error Response ===		=== DAP4 Error Response ===

Ndp: /* Asynchronous Response Resource Role */

2013-11-07T03:54:18Z

Asynchronous Response Resource Role

← Older revision		Revision as of 03:54, 7 November 2013
Line 662:		Line 662:
	==== Asynchronous Response Resource Role ====		==== Asynchronous Response Resource Role ====

	DAP4 ~~Error~~ Responses are identified by the resource role:		DAP4 Asynchronous Responses are identified by the resource role:

	: '''<font size="2"><code><nowiki>http://services.opendap.org/dap4/async</nowiki></code></font>'''		: '''<font size="2"><code><nowiki>http://services.opendap.org/dap4/async</nowiki></code></font>'''

Ndp: /* DAP4 Error Response */

2013-11-06T23:45:00Z

DAP4 Error Response

← Older revision		Revision as of 23:45, 6 November 2013
Line 652:		Line 652:

	Must return the NetCDF representation of the Data Response, if available. If no such representation is available then the server MAY return an HTTP status of 404 or even 415.		Must return the NetCDF representation of the Data Response, if available. If no such representation is available then the server MAY return an HTTP status of 404 or even 415.

			=== [[DAP4:_Asynchronous_Request-Response_Proposal_v3 \| DAP4 Asynchronous Response]] ===

			Some servers may not be able to fulfill DAP4 service requests in a timely manner.
			* A DAP4 server that is retrieving data content from a near-line tape storage subsystem might take several minutes to access a particular data holding.
			* A DAP4 server that is providing access to data held in an Amazon Web Services Glacier Vault will have to wait ~4 hours before it can retrieve a particular holding.
			In these circumstances the server may return the [[DAP4:_Asynchronous_Request-Response_Proposal_v3 \| DAP4 Asynchronous Response]].

			==== Asynchronous Response Resource Role ====

			DAP4 Error Responses are identified by the resource role:

			: '''<font size="2"><code><nowiki>http://services.opendap.org/dap4/async</nowiki></code></font>'''

			==== Normative Encoding of the Asynchronous Response ====

			The normative XML representation for the Error Response is defined in Appendix x "Normative XML Encoding of the Error Response". The media type for the normative XML representation is:

			: <font size="2"><code>'''application/vnd.org.opendap.dap4.async.xml'''</code></font>


	=== DAP4 Error Response ===		=== DAP4 Error Response ===

Ndp: /* Web Services */

2013-11-06T23:35:09Z

Web Services

← Older revision		Revision as of 23:35, 6 November 2013
Line 199:		Line 199:
	: A internet media type is a two-part identifier for resource encoding schemes [http://en.wikipedia.org/wiki/Internet_media_type]. (E.g., "text/html", "text/plain", "application/octet-stream".)		: A internet media type is a two-part identifier for resource encoding schemes [http://en.wikipedia.org/wiki/Internet_media_type]. (E.g., "text/html", "text/plain", "application/octet-stream".)

	== Web ~~Services~~ ==		== DAP4 Web Service Responses ==

	The core of the DAP4 Web Service protocol consists of the three standard response types: Dataset Services Response (DSR), Dataset Metadata Response (DMR), and Dataset Data Response (Data). Each dataset served by a DAP4 compliant server MUST provide these three response types.		The core of the DAP4 Web Service protocol consists of the three standard response types: Dataset Services Response (DSR), Dataset Metadata Response (DMR), and Dataset Data Response (Data). Each dataset served by a DAP4 compliant server MUST provide these three response types.

DennisHeimbigner: /* DAP4 Error Response */

2012-12-08T20:59:32Z

DAP4 Error Response

@@ Line 657: / Line 657: @@
 The DAP4 protocol returns error information using an Error response. If a request for any of the three basic responses cannot be completed then an Error response is returned in its place.
-A DAP4 error response must include the following information:
+The normative XML representation for the Error Response is defined by the following RELAX-NG schema.
-* a standard code (?do we want to include a code, or is just the message enough?)
+The Error element has one optional attribute: the ''httpcode'' which is a standard HTTP protocol return code indicating the general class of error. When possible, this code should match the return code in the HTTP headers for the response.
-* a message with information describing the error
 ==== Error Response Resource Role ====

Ndp: /* Service Behavior */

2012-09-27T21:54:16Z

Service Behavior

← Older revision		Revision as of 21:54, 27 September 2012
Line 534:		Line 534:

	==== Service Behavior ====		==== Service Behavior ====
	Every DAP4 compliant server MUST return the normative representation ([[DAP4: Data Model \| as described here ]]) of the Data Response when a client attempts to access a dataset URL with the suffix ".dap" appended to it. The DAP4 server MAY return alternate representations if the client indicates that it can accept them and the server can provide them.		Every DAP4 compliant server MUST return the normative representation ([[DAP4: Data Model \| as described here ]]) of the Data Response when a client attempts to access a dataset URL with the suffix "<font size="2"><code>'''.dap'''</code></font>" appended to it. The DAP4 server MAY return alternate representations if the client indicates that it can accept them and the server can provide them.

	When an HTTP GET request is made on a base DAP dataset URL with the suffix <font size="2"><code>'''.dap'''</code></font> added to it:		When an HTTP GET request is made on a base DAP dataset URL with the suffix <font size="2"><code>'''.dap'''</code></font> added to it:

Ndp: /* Service Behavior */

2012-09-27T21:53:40Z

Service Behavior

← Older revision		Revision as of 21:53, 27 September 2012
Line 421:		Line 421:
	==== Service Behavior ====		==== Service Behavior ====

	Every DAP4 compliant server MUST return the normative representation (an XML document [[DAP4: Data Model \| as described here ]]) of the Dataset Metadata Response when a client attempts to access a dataset URL with the suffix ".dmr" appended to it. The DAP4 server MAY return alternate representations if the client indicates that it can accept them and the server can provide them.		Every DAP4 compliant server MUST return the normative representation (an XML document [[DAP4: Data Model \| as described here ]]) of the Dataset Metadata Response when a client attempts to access a dataset URL with the suffix "<font size="2"><code>'''.dmr'''</code></font>" appended to it. The DAP4 server MAY return alternate representations if the client indicates that it can accept them and the server can provide them.

	When an HTTP GET request is made on a base DAP dataset URL with the suffix <font size="2"><code>'''.dmr'''</code></font> added to it:		When an HTTP GET request is made on a base DAP dataset URL with the suffix <font size="2"><code>'''.dmr'''</code></font> added to it:

EthanDavis: /* Introduction */

2012-09-26T23:00:50Z

Introduction

Show changes