Difference between revisions of "Transaction Web Service"

From Fusion Registry Wiki
Jump to navigation Jump to search
(Overview)
Line 5: Line 5:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/registry/tx/searchTransactions</b>
+
|style="background-color:#eaecf0"|<b>Entry Point</b> || <b> /ws/registry/tx/searchTransactions</b>
 
|-
 
|-
|style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:green'><b>Public</b></span>
+
|style="background-color:#eaecf0"|<b>Access</b> || <span style='color:green'><b>Public</b></span>
 
|-
 
|-
|style="background-color:#eaecf0"|<b>Http Method</b>|| GET
+
|style="background-color:#eaecf0"|<b>Http Method</b> || GET
 
|-
 
|-
|style="background-color:#eaecf0"|<b>Accepts</b>|| CSV, XLSX, SDMX-ML, SDMX-EDI (any format for which there is a Data Reader)
+
|style="background-color:#eaecf0"|<b>Response Format</b> || application/json
 
|-
 
|-
|style="background-color:#eaecf0"|<b>Compression</b> || Zip files supported, if loading from URL gzip responses supported
+
|style="background-color:#eaecf0"|<b>Response Statuses</b> || <p><b>200</b> - Submisson Accepted</p>
|-
 
|style="background-color:#eaecf0"|<b>Content-Type</b>|| <p>1. multipart/form-data (if attaching file) – the attached file must be in field name of uploadFile</p>
 
<p>2. application/text or application/xml (if submitting data in the body of the POST)</p>
 
|-
 
|style="background-color:#eaecf0"|<b>Response Format</b>|| Determined by [[Data Formats|Accept Header]] - default SDMX 2.1 Structure Specific
 
|-
 
|style="background-color:#eaecf0"|<b>Response Statuses</b>|| <p><b>200</b> - Submisson Accepted</p>
 
 
<p><b>400</b> - Submission could not be performed (either an unreadable dataset, or unresolvable reference to a required structure)</p>
 
<p><b>400</b> - Submission could not be performed (either an unreadable dataset, or unresolvable reference to a required structure)</p>
 
<p><b>401</b> - Unauthorized (if access has been restricted)</p>
 
<p><b>401</b> - Unauthorized (if access has been restricted)</p>
 
<p><b>500</b> - Server Error</p>
 
<p><b>500</b> - Server Error</p>
 
|}
 
|}

Revision as of 01:51, 4 February 2021

Overview

The Transaction Web Service provides access to all the structural metadata content of the Fusion Registry (including any content that has been subsequently deleted). A Transaction is the submission of a structure, group of structures or data registration.

Entry Point /ws/registry/tx/searchTransactions
Access Public
Http Method GET
Response Format application/json
Response Statuses

200 - Submisson Accepted

400 - Submission could not be performed (either an unreadable dataset, or unresolvable reference to a required structure)

401 - Unauthorized (if access has been restricted)

500 - Server Error