Query Structures Web Service - Revision history

Plazarou: /* Headers */

2023-06-09T10:19:23Z

‎Headers

2023-06-08T14:42:16Z

‎Headers

2023-06-08T14:38:30Z

‎Headers

2021-03-27T10:32:24Z

‎URL Request Parameters

2021-03-27T10:31:57Z

‎URL Request Parameters

2021-01-20T22:09:14Z

‎Request Parameters

2021-01-20T22:08:40Z

‎Overview

2021-01-20T22:08:00Z

‎Request Parameters

2021-01-20T22:07:27Z

‎Request Parameters

2021-01-20T22:07:01Z

‎Request Parameters

@@ Line 49: / Line 49: @@
 |-
 |style="background-color:#eaecf0; width:15%;"|<b>If-Modified-Since</b>|| style="width:42%;" | The server sends back the requested resource, with a 200 status, only if it has been last modified after the specified date. If the resource has not been modified since, the response is a 304 without any body. <br>
-'''Note:''' The current implementation has a limitiation in that it does not cater for deletions for the specified query after the specified date, except for in the case of all structures. For example, querying for a codelist subset may return a 304 response even if there was a deletion of one of the codelists beyond the specified date. This is not true for a query for all structures.
+'''Note:''' The current implementation has a limitiation in that any deletion of structural metadata will reset all datetimes of existing structures to the current time. This is to avoid the "false negative" scenario whereby querying for all structures would not return a 200 response if a structure had been deleted. The current implementation does give "false positives" - i.e. a structure has changed when it has not.
 || A date in the expected format of: <br> <Day-Name>, <Day> <Month-Name> <Year> <Hour>:<Minute>:<Second> GMT <br> Examples: <br>
 Fri, 31 Dec 2023 23:59:59 GMT<br>

@@ Line 48: / Line 48: @@
 Accept-Language : all (all languages – no filter)<br>
 |-
-|style="background-color:#eaecf0; width:15%;"|<b>If-Modified-Since</b>|| style="width:42%;" | The server sends back the requested resource, with a 200 status, only if it has been last modified after the specified date. If the resource has not been modified since, the response is a 304 without any body.
+|style="background-color:#eaecf0; width:15%;"|<b>If-Modified-Since</b>|| style="width:42%;" | The server sends back the requested resource, with a 200 status, only if it has been last modified after the specified date. If the resource has not been modified since, the response is a 304 without any body. <br>
 || A date in the expected format of: <br> <Day-Name>, <Day> <Month-Name> <Year> <Hour>:<Minute>:<Second> GMT <br> Examples: <br>
 Fri, 31 Dec 2023 23:59:59 GMT<br>

@@ Line 39: / Line 39: @@
 |-
 |style="background-color:#eaecf0"|<b>Accept-Language</b>||
-This optional header can be used to set the locale to return any multilingual text in (names and
+This optional header can be used to set the locale to return any multilingual text in (names and descriptions). If the text does not exist in the specified locale, then the default rules will be applied
-descriptions). If the text does not
+to find the next best appropriate locale.
+|
 Examples:<br>
@@ Line 51: / Line 47: @@
 Accept-Language : * (all languages – no filter)<br>
 Accept-Language : all (all languages – no filter)<br>
 |}

@@ Line 268: / Line 268: @@
 This will result in the response being saved to a file.
-The file extension is not required as the Fusion Registry will determine the extension based on the response format.
+The file extension is not required as the Registry will determine the extension based on the response format.
+|
 String

@@ Line 188: / Line 188: @@
 | '''partial'''
+|
-If set to true creates partial Codelists in the response based on the Fusion Registry Content Constraints defining allowable content.
+If set to true creates partial Codelists in the response based on the Fusion Metadata Registry Content Constraints defining allowable content.
 The pre-requisite is that the query must be for a single constrainable structure (Provision Agreements, Dataflow, or Data Structure) and include references.

@@ Line 135: / Line 135: @@
 <pre>protocol://domain/ws/public/sdmxapi/rest/resource/agencyID/resourceID/version/itemID</pre>
-=Request Parameters=
+=URL Request Parameters=
 The request parameters are all optional and can be used to define the response detail, format, and any
 additional structures which reference, or are referenced by those identified in the query path.

@@ Line 9: / Line 9: @@
 |style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/public/sdmxapi/rest/ </b>
 |-
-|style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:green'><b>Secure</b></span> Public
+|style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:green'><b>Public</b></span>
 |-
 |style="background-color:#eaecf0"|<b>Authentication</b>|| None

@@ Line 136: / Line 136: @@
 =Request Parameters=
 {| class="wikitable"
 ! '''Parameter'''