Skip to Content

Changes for page Part I. Message Namespace

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

Summary

Details

Page properties
Tags
... ... @@ -1,1 +1,0 @@
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>>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]].
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.
8 8  
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.
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.
10 10  
11 -In general, every message in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] follows common format of:
11 +In general, every message in SDMX follows common format of:
12 12  
13 13  * Header
14 14  * Payload (0..n)
... ... @@ -26,15 +26,14 @@
26 26  
27 27  Referenced Namespaces:
28 28  
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
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|
38 38  
39 39  Contents:
40 40  7 Global Elements
... ... @@ -43,15 +43,15 @@
43 43  
44 44  === 2.1.2 Global Elements ===
45 45  
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(%%), .
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, .
47 47  
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.
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.
49 49  
50 50  **GenericMetadata (GenericMetadataType):** GenericMetadata contains reported metadata in a format which supports any metadata structure definition.
51 51  
52 -**RegistryInterface (RegistryInterfaceType):** RegistryInterface is used to conduct all interactions with the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Services.
51 +**RegistryInterface (RegistryInterfaceType):** RegistryInterface is used to conduct all interactions with the SDMX Registry Services.
53 53  
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.
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.
55 55  
56 56  **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.
57 57  
... ... @@ -67,10 +67,9 @@
67 67  
68 68  Element Documentation:
69 69  
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.
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.|
74 74  
75 75  **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.
76 76  
... ... @@ -84,11 +84,10 @@
84 84  
85 85  Element Documentation:
86 86  
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.
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.|
92 92  
93 93  **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.
94 94  
... ... @@ -102,11 +102,10 @@
102 102  
103 103  Element Documentation:
104 104  
105 -(% style="width:1228.29px" %)
106 -|**Name**|(% style="width:327px" %)**Type**|(% style="width:755px" %)**Documentation**
107 -|Header|(% style="width:327px" %)StructureSpecificDat aHeaderType|(% style="width:755px" %)
108 -|DataSet|(% style="width:327px" %)*DataSetType*|(% style="width:755px" %)
109 -|Footer|(% style="width:327px" %)FooterType|(% style="width:755px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
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.|
110 110  
111 111  **GenericMetadataType:** GenericMetadataType defines the contents of a generic metadata message.
112 112