OECD.Stat SDMX web service Web Service

OECD.Stat SDMX web service

Click here for a complete list of operations.

GetDataStructureDefinition

Use this method to retrieve the Data Structure Definitions (as well as Code lists and Concepts) from an .Stat dataset.
Note: As the requested input parameter is an xml document, you can not try the method using this webservice presentation page.

Input: SDMX QueryMessage (in SDMX-ML format)
Output: SDMX StructureMessage (in SDMX-ML format)

When authenticated access is needed, then previously do the following steps:

Step n° 1: Get the current .Stat public encryption key:
/OECDStatWS_Authentication/OECDStatWS_Authentication.asmx?op=GetPublicKey
Step n° 2: RSA-encrypt your password using the public encryption key and authenticate yourself:
/OECDStatWS_Authentication/OECDStatWS_Authentication.asmx?op=AuthenticateWithLogonUpdate
The 'AuthenticateWithLogonUpdate' method returns a session ID and updates the username. Provide this session ID, your user name and the domain as URL options 'sessionid', 'login' and 'domain' to the GetDataStructureDefinition method.
Note: You can reuse the same session ID for several SDMX requests within a certain timeout. The authentication procedure might be modified in the future.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Sdmxws/sdmx.asmx HTTP/1.1
Host: stats.oecd.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://stats.oecd.org/OECDStatWS/SDMX/GetDataStructureDefinition"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDataStructureDefinition xmlns="http://stats.oecd.org/OECDStatWS/SDMX/">
      <QueryMessage>xml</QueryMessage>
    </GetDataStructureDefinition>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDataStructureDefinitionResponse xmlns="http://stats.oecd.org/OECDStatWS/SDMX/">
      <GetDataStructureDefinitionResult>xml</GetDataStructureDefinitionResult>
    </GetDataStructureDefinitionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Sdmxws/sdmx.asmx HTTP/1.1
Host: stats.oecd.org
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetDataStructureDefinition xmlns="http://stats.oecd.org/OECDStatWS/SDMX/">
      <QueryMessage>xml</QueryMessage>
    </GetDataStructureDefinition>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetDataStructureDefinitionResponse xmlns="http://stats.oecd.org/OECDStatWS/SDMX/">
      <GetDataStructureDefinitionResult>xml</GetDataStructureDefinitionResult>
    </GetDataStructureDefinitionResponse>
  </soap12:Body>
</soap12:Envelope>