Skip to Content

Changes for page Part I. Message Namespace

Last modified by Elena on 2025/09/10 11:19
From version 3.1
edited by Helena
on 2025/07/02 00:58
Change comment: There is no comment for this version
To version 3.4
edited by Helena
on 2025/07/02 10:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Tags
... ... @@ -1,0 +1,1 @@
1 +Category scheme|Code list|Concept scheme|Data set|Data structure definition|Dataflow|Dimension|Hierarchical code list|Metadata structure definition|Metadataflow|Reporting taxonomy|Representation|SDMX Registry|SDMX-ML|Statistical data and metadata exchange|Structural metadata
Content
... ... @@ -4,11 +4,11 @@
4 4  
5 5  = 1 Introduction =
6 6  
7 -At the core of the SDMX XML messages are the message namespaces. These namespaces define the general structure of all messages and define the specific messages that are available for exchange in SDMX.
7 +At the core of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] XML messages are the message namespaces. These namespaces define the general structure of all messages and define the specific messages that are available for exchange in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].
8 8  
9 -There are two namespaces associated with the messages. The main namespace schema which defines every message in SDMX is http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message. Associated with this is another sub-namespace, http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer. This namespace defines footer level information that is available in messages which might require non-standard payload information to be transmitted.
9 +There are two namespaces associated with the messages. The main namespace schema which defines every message in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message. Associated with this is another sub-namespace, http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer. This namespace defines footer (% style="color:#e74c3c" %)level(%%) information that is available in messages which might require non-standard payload information to be transmitted.
10 10  
11 -In general, every message in SDMX follows common format of:
11 +In general, every message in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] follows common format of:
12 12  
13 13  * Header
14 14  * Payload (0..n)
... ... @@ -26,14 +26,15 @@
26 26  
27 27  Referenced Namespaces:
28 28  
29 -|**Namespace**|**Prefix**|
30 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common|
31 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|dsd|
32 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer|footer|
33 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic|metadata|
34 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/registry|registry|
35 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/structure|structure|
36 -|http://www.w3.org/2001/XMLSchema|xs|
29 +(% style="width:973.294px" %)
30 +|(% style="width:610px" %)**Namespace**|(% style="width:360px" %)**Prefix**
31 +|(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|(% style="width:360px" %)common
32 +|(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|(% style="width:360px" %)dsd
33 +|(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer|(% style="width:360px" %)footer
34 +|(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic|(% style="width:360px" %)metadata
35 +|(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/registry|(% style="width:360px" %)registry
36 +|(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/structure|(% style="width:360px" %)structure
37 +|(% style="width:610px" %)http://www.w3.org/2001/XMLSchema|(% style="width:360px" %)xs
37 37  
38 38  Contents:
39 39  7 Global Elements
... ... @@ -42,15 +42,15 @@
42 42  
43 43  === 2.1.2 Global Elements ===
44 44  
45 -**Structure (StructureType):** Structure is a message that contains structural metadata. It may contain any of the following; categorisations, category schemes, code lists, concepts (concept schemes), data and metadata constraints, data flows, hierarchical code lists, metadata flows, metadata structure definitions, organisation schemes, processes, reporting taxonomies, structure maps, representation maps, .
46 +**Structure (StructureType):** Structure is a message that contains [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. It may contain any of the following; categorisations, [[category schemes>>doc:sdmx:Glossary.Category scheme.WebHome]], [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], (% style="color:#e74c3c" %)concepts(%%) ([[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]]), data and metadata (% style="color:#e74c3c" %)constraints(%%), [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]], [[hierarchical code lists>>doc:sdmx:Glossary.Hierarchical code list.WebHome]], [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], organisation schemes, processes, [[reporting taxonomies>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]], structure (% style="color:#e74c3c" %)maps(%%), [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)maps(%%), .
46 46  
47 -**StructureSpecificData (StructureSpecificDataType):** StructureSpecificData is used to convey data structure specific according to data structure definition. The payload of this message (i.e. the data sets) will be based on XML schemas which are specific to the data structure definition and the orientation (i.e. the observation dimension) of the data.
48 +**StructureSpecificData (StructureSpecificDataType):** StructureSpecificData is used to convey data structure specific according to [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The payload of this message (i.e. the [[data sets>>doc:sdmx:Glossary.Data set.WebHome]]) will be based on XML schemas which are specific to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and the orientation (i.e. the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]) of the data.
48 48  
49 49  **GenericMetadata (GenericMetadataType):** GenericMetadata contains reported metadata in a format which supports any metadata structure definition.
50 50  
51 -**RegistryInterface (RegistryInterfaceType):** RegistryInterface is used to conduct all interactions with the SDMX Registry Services.
52 +**RegistryInterface (RegistryInterfaceType):** RegistryInterface is used to conduct all interactions with the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Services.
52 52  
53 -**SubmitStructureRequest (SubmitStructureRequestType):** SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.
54 +**SubmitStructureRequest (SubmitStructureRequestType):** SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, (% style="color:#e74c3c" %)concepts(%%) and [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], etc.) to be submitted may be communicated in-line or be supplied in a referenced [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure messages external to the registry. A response will indicate status and contain any relevant error information.
54 54  
55 55  **SubmitStructureResponse (SubmitStructureResponseType):** SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.
56 56  
... ... @@ -66,9 +66,10 @@
66 66  
67 67  Element Documentation:
68 68  
69 -|**Name**|**Type**|**Documentation**|
70 -|Header|*BaseHeaderType*| |
71 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.|
70 +(% style="width:1007.29px" %)
71 +|**Name**|(% style="width:192px" %)**Type**|(% style="width:662px" %)**Documentation**
72 +|Header|(% style="width:192px" %)*BaseHeaderType*|(% style="width:662px" %)
73 +|Footer|(% style="width:192px" %)FooterType|(% style="width:662px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
72 72  
73 73  **StructureType:** StructureType defines the contents of a structure message. The payload is optional since this message may be returned from a web service with only information in the footer.
74 74  
... ... @@ -82,10 +82,11 @@
82 82  
83 83  Element Documentation:
84 84  
85 -|**Name**|**Type**|**Documentation**|
86 -|Header|StructureHeaderType| |
87 -|Structures|StructuresType| |
88 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.|
87 +(% style="width:1007.29px" %)
88 +|**Name**|(% style="width:228px" %)**Type**|(% style="width:589px" %)**Documentation**
89 +|Header|(% style="width:228px" %)StructureHeaderType|(% style="width:589px" %)
90 +|Structures|(% style="width:228px" %)StructuresType|(% style="width:589px" %)
91 +|Footer|(% style="width:228px" %)FooterType|(% style="width:589px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
89 89  
90 90  **StructureSpecificDataType:** StructureSpecificDataType defines the structure of the structure specific data message. Note that the data set payload type is abstract, and therefore it will have to be assigned a type in an instance. This type must be derived from the base type referenced. This base type defines a general structure which can be followed to allow for generic processing of the data even if the exact details of the data structure specific format are not known.
91 91  
... ... @@ -99,10 +99,11 @@
99 99  
100 100  Element Documentation:
101 101  
102 -|**Name**|**Type**|**Documentation**|
103 -|Header|StructureSpecificDat aHeaderType| |
104 -|DataSet|*DataSetType*| |
105 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.|
105 +(% style="width:1005.29px" %)
106 +|**Name**|(% style="width:269px" %)**Type**|(% style="width:585px" %)**Documentation**
107 +|Header|(% style="width:269px" %)StructureSpecificDat aHeaderType|(% style="width:585px" %)
108 +|DataSet|(% style="width:269px" %)*DataSetType*|(% style="width:585px" %)
109 +|Footer|(% style="width:269px" %)FooterType|(% style="width:585px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
106 106  
107 107  **GenericMetadataType:** GenericMetadataType defines the contents of a generic metadata message.
108 108  
... ... @@ -116,10 +116,11 @@
116 116  
117 117  Element Documentation:
118 118  
119 -|**Name**|**Type**|**Documentation**|
120 -|Header|GenericMetadataHeade rType| |
121 -|MetadataSet|MetadataSetType| |
122 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.|
123 +(% style="width:1012.29px" %)
124 +|**Name**|(% style="width:309px" %)**Type**|(% style="width:593px" %)**Documentation**
125 +|Header|(% style="width:309px" %)GenericMetadataHeaderType|(% style="width:593px" %)
126 +|MetadataSet|(% style="width:309px" %)MetadataSetType|(% style="width:593px" %)
127 +|Footer|(% style="width:309px" %)FooterType|(% style="width:593px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
123 123  
124 124  **RegistryInterfaceType:** This is a type which describes a structure for holding all of the various dedicated registry interface message types.
125 125  
... ... @@ -135,10 +135,10 @@
135 135  
136 136  |**Name**|**Type**|**Documentation**|
137 137  |Header|BasicHeaderType| |
138 -|SubmitRegistrationsR equest|SubmitRegistrationsR equestType|SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.|
139 -|SubmitRegistrationsR esponse|SubmitRegistrationsR esponseType|SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.|
140 -|QueryRegistrationReq uest|QueryRegistrationReq uestType|QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.|
141 -|QueryRegistrationRes ponse|QueryRegistrationRes ponseType|QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.|
143 +|SubmitRegistrationsRequest|SubmitRegistrationsRequestType|SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.|
144 +|SubmitRegistrationsResponse|SubmitRegistrationsR esponseType|SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.|
145 +|QueryRegistrationRequest|QueryRegistrationReq uestType|QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.|
146 +|QueryRegistrationResponse|QueryRegistrationRes ponseType|QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.|
142 142  |SubmitStructureReque st|SubmitStructureReque stType|SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.|
143 143  |SubmitStructureRespo nse|SubmitStructureRespo nseType|SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.|
144 144  |SubmitSubscriptionsR equest|SubmitSubscriptionsR equestType|SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.|