Changes for page Part I. Message Namespace
Last modified by Elena on 2025/09/10 11:19
Summary
-
Page properties (2 modified, 0 added, 0 removed)
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.Statisticaldata 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.Statisticaldata 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.Statisticaldata 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.Structuralmetadata.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.Datastructure 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.Datastructure 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.SDMXRegistry.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 ... ... @@ -77,7 +77,7 @@ 77 77 Derivation: 78 78 79 79 MessageType (restriction) 80 - StructureType78 + StructureType 81 81 82 82 Content: 83 83 Header, Structures?, Footer? ... ... @@ -84,18 +84,17 @@ 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 95 95 Derivation: 96 96 97 -MessageType (restriction) 98 - StructureSpecificDataType94 +MessageType (restriction) 95 + StructureSpecificDataType 99 99 100 100 Content: 101 101 Header, DataSet*, Footer? ... ... @@ -102,11 +102,10 @@ 102 102 103 103 Element Documentation: 104 104 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. 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 ... ... @@ -113,7 +113,7 @@ 113 113 Derivation: 114 114 115 115 MessageType (restriction) 116 - GenericMetadataType112 + GenericMetadataType 117 117 118 118 Content: 119 119 Header, MetadataSet*, Footer? ... ... @@ -120,11 +120,10 @@ 120 120 121 121 Element Documentation: 122 122 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. 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.| 128 128 129 129 **RegistryInterfaceType:** This is a type which describes a structure for holding all of the various dedicated registry interface message types. 130 130 ... ... @@ -131,7 +131,7 @@ 131 131 Derivation: 132 132 133 133 MessageType (restriction) 134 - RegistryInterfaceType129 + RegistryInterfaceType 135 135 136 136 Content: 137 137 Header, (SubmitRegistrationsRequest|SubmitRegistrationsResponse|QueryRegistrationRequest|QueryRegistrationResponse|SubmitStructureRequest|SubmitStructureResponse|SubmitSubscriptionsRequest|SubmitSubscriptionsResponse|QuerySubscriptionRequest|QuerySubscriptionResponse|NotifyRegistryEvent)?, Footer? ... ... @@ -138,20 +138,20 @@ 138 138 139 139 Element Documentation: 140 140 141 -|**Name**|**Type**|**Documentation**| 142 -|Header|BasicHeaderType| |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.| 147 -|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.| 148 -|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.| 149 -|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.| 150 -|SubmitSubscriptionsR esponse|SubmitSubscriptionsR esponseType|SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.| 151 -|QuerySubscriptionReq uest|QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.| 152 -|QuerySubscriptionRes ponse|QuerySubscriptionRes ponseType|QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.| 153 -|NotifyRegistryEvent|NotifyRegistryEventT ype|NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.| 154 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.| 136 +|**Name**|**Type**|**Documentation**| 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.| 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 +|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 +|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.| 145 +|SubmitSubscriptionsR esponse|SubmitSubscriptionsR esponseType|SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.| 146 +|QuerySubscriptionReq uest|QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.| 147 +|QuerySubscriptionRes ponse|QuerySubscriptionRes ponseType|QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.| 148 +|NotifyRegistryEvent|NotifyRegistryEventT ype|NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.| 149 +|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.| 155 155 156 156 **SubmitStructureRequestType:** SubmitStructureRequestType defines the structure of a registry submit structure request document. 157 157 ... ... @@ -158,8 +158,8 @@ 158 158 Derivation: 159 159 160 160 MessageType (restriction) 161 - RegistryInterfaceType (restriction)162 - SubmitStructureRequestType156 + RegistryInterfaceType (restriction) 157 + SubmitStructureRequestType 163 163 164 164 Content: 165 165 Header, SubmitStructureRequest ... ... @@ -166,9 +166,9 @@ 166 166 167 167 Element Documentation: 168 168 169 -|**Name**|**Type**|**Documentation**| 170 -|Header|BasicHeaderType| |171 -|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.| 164 +|**Name**|**Type**|**Documentation**| 165 +|Header|BasicHeaderType|| 166 +|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.| 172 172 173 173 **SubmitStructureResponseType:** SubmitStructureResponseType defines the structure of a registry submit registration response document. 174 174 ... ... @@ -175,8 +175,8 @@ 175 175 Derivation: 176 176 177 177 MessageType (restriction) 178 - RegistryInterfaceType (restriction)179 - SubmitStructureResponseType173 + RegistryInterfaceType (restriction) 174 + SubmitStructureResponseType 180 180 181 181 Content: 182 182 Header, SubmitStructureResponse, Footer? ... ... @@ -183,10 +183,10 @@ 183 183 184 184 Element Documentation: 185 185 186 -|**Name**|**Type**|**Documentation**| 187 -|Header|BasicHeaderType| |188 -|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.| 189 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.| 181 +|**Name**|**Type**|**Documentation**| 182 +|Header|BasicHeaderType|| 183 +|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.| 184 +|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.| 190 190 191 191 **ErrorType:** ErrorType describes the structure of an error response. 192 192 ... ... @@ -195,8 +195,8 @@ 195 195 196 196 Element Documentation: 197 197 198 -|**Name**|**Type**|**Documentation**| 199 -|ErrorMessage|CodedStatusMessageTy pe|ErrorMessage contains the error message. It can occur multiple times to communicate message for multiple errors, or to communicate the error message in parallel languages. If both messages for multiple errors and parallel language messages are used, then each error message should be given a code in order to distinguish message for unique errors.| 193 +|**Name**|**Type**|**Documentation**| 194 +|ErrorMessage|CodedStatusMessageTy pe|ErrorMessage contains the error message. It can occur multiple times to communicate message for multiple errors, or to communicate the error message in parallel languages. If both messages for multiple errors and parallel language messages are used, then each error message should be given a code in order to distinguish message for unique errors.| 200 200 201 201 ***BaseHeaderType*:** BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this 202 202 ... ... @@ -205,23 +205,23 @@ 205 205 206 206 Element Documentation: 207 207 208 -|**Name**|**Type**|**Documentation**| 209 -|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 210 -|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 211 -|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 212 -|Sender|SenderType|Sender is information about the party that is transmitting the message.| 213 -|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 214 -|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.| 215 -|Structure|*PayloadStructureType*|Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.| 216 -|DataProvider|DataProviderReferenc eType|DataProvider identifies the provider of the data for a data message.| 217 -|MetadataProvider|MetadataProviderRefe renceType|MetadataProvider identifies the provider of the metadata for a metadata message.| 218 -|DataSetAction|ActionType|DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).| 219 -|DataSetID|IDType|DataSetID provides an identifier for a contained data set.| 220 -|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.| 221 -|ReportingBegin|ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).| 222 -|ReportingEnd|ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).| 223 -|EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.| 224 -|Source|TextType|Source provides human-readable information about the source of the data.| 203 +|**Name**|**Type**|**Documentation**| 204 +|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 205 +|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 206 +|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 207 +|Sender|SenderType|Sender is information about the party that is transmitting the message.| 208 +|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 209 +|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.| 210 +|Structure|*PayloadStructureType*|Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.| 211 +|DataProvider|DataProviderReferenc eType|DataProvider identifies the provider of the data for a data message.| 212 +|MetadataProvider|MetadataProviderRefe renceType|MetadataProvider identifies the provider of the metadata for a metadata message.| 213 +|DataSetAction|ActionType|DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).| 214 +|DataSetID|IDType|DataSetID provides an identifier for a contained data set.| 215 +|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.| 216 +|ReportingBegin|ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).| 217 +|ReportingEnd|ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).| 218 +|EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.| 219 +|Source|TextType|Source provides human-readable information about the source of the data.| 225 225 226 226 **StructureHeaderType:** StructureHeaderType defines the structure for structural metadata messages. 227 227 ... ... @@ -228,7 +228,7 @@ 228 228 Derivation: 229 229 230 230 BaseHeaderType (restriction) 231 - StructureHeaderType226 + StructureHeaderType 232 232 233 233 Content: 234 234 ID, Test, Prepared, Sender, Receiver*, Name*, Source ... ... @@ -235,14 +235,14 @@ 235 235 236 236 Element Documentation: 237 237 238 -|**Name**|**Type**|**Documentation**| 239 -|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 240 -|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 241 -|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 242 -|Sender|SenderType|Sender is information about the party that is transmitting the message.| 243 -|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 244 -|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.| 245 -|Source|TextType|Source provides human-readable information about the source of the data.| 233 +|**Name**|**Type**|**Documentation**| 234 +|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 235 +|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 236 +|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 237 +|Sender|SenderType|Sender is information about the party that is transmitting the message.| 238 +|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 239 +|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.| 240 +|Source|TextType|Source provides human-readable information about the source of the data.| 246 246 247 247 **StructureSpecificDataHeaderType:** StructureSpecificDataHeaderType defines the header structure for a structure specific data message. 248 248 ... ... @@ -249,7 +249,7 @@ 249 249 Derivation: 250 250 251 251 BaseHeaderType (restriction) 252 - StructureSpecificDataHeaderType247 + StructureSpecificDataHeaderType 253 253 254 254 Content: 255 255 ID, Test, Prepared, Sender, Receiver*, Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source ... ... @@ -256,22 +256,22 @@ 256 256 257 257 Element Documentation: 258 258 259 -|**Name**|**Type**|**Documentation**| 260 -|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 261 -|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 262 -|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 263 -|Sender|SenderType|Sender is information about the party that is transmitting the message.| 264 -|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 265 -|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.| 266 -|Structure|StructureSpecificDat aStructureType|Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.| 267 -|DataProvider|DataProviderReferenc eType|DataProvider identifies the provider of the data for a data message.| 268 -|DataSetAction|ActionType|DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).| 269 -|DataSetID|IDType|DataSetID provides an identifier for a contained data set.| 270 -|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.| 271 -|ReportingBegin|ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).| 272 -|ReportingEnd|ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).| 273 -|EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.| 274 -|Source|TextType|Source provides human-readable information about the source of the data.| 254 +|**Name**|**Type**|**Documentation**| 255 +|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 256 +|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 257 +|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 258 +|Sender|SenderType|Sender is information about the party that is transmitting the message.| 259 +|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 260 +|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.| 261 +|Structure|StructureSpecificDat aStructureType|Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.| 262 +|DataProvider|DataProviderReferenc eType|DataProvider identifies the provider of the data for a data message.| 263 +|DataSetAction|ActionType|DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).| 264 +|DataSetID|IDType|DataSetID provides an identifier for a contained data set.| 265 +|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.| 266 +|ReportingBegin|ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).| 267 +|ReportingEnd|ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).| 268 +|EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.| 269 +|Source|TextType|Source provides human-readable information about the source of the data.| 275 275 276 276 **GenericMetadataHeaderType:** GenericMetadataHeaderType defines the header format for generic reference metadata. 277 277 ... ... @@ -278,7 +278,7 @@ 278 278 Derivation: 279 279 280 280 BaseHeaderType (restriction) 281 - GenericMetadataHeaderType276 + GenericMetadataHeaderType 282 282 283 283 Content: 284 284 ID, Test, Prepared, Sender, Receiver*, Name*, Structure+, MetadataProvider?, DataSetAction?, DataSetID*, Extracted?, Source ... ... @@ -285,19 +285,19 @@ 285 285 286 286 Element Documentation: 287 287 288 -|**Name**|**Type**|**Documentation**| 289 -|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 290 -|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 291 -|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 292 -|Sender|SenderType|Sender is information about the party that is transmitting the message.| 293 -|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 294 -|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.| 295 -|Structure|GenericMetadataStruc tureType|Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.| 296 -|MetadataProvider|MetadataProviderRefe renceType|MetadataProvider identifies the provider of the metadata for a metadata message.| 297 -|DataSetAction|ActionType|DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).| 298 -|DataSetID|IDType|DataSetID provides an identifier for a contained data set.| 299 -|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.| 300 -|Source|TextType|Source provides human-readable information about the source of the data.| 283 +|**Name**|**Type**|**Documentation**| 284 +|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 285 +|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 286 +|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 287 +|Sender|SenderType|Sender is information about the party that is transmitting the message.| 288 +|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 289 +|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.| 290 +|Structure|GenericMetadataStruc tureType|Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.| 291 +|MetadataProvider|MetadataProviderRefe renceType|MetadataProvider identifies the provider of the metadata for a metadata message.| 292 +|DataSetAction|ActionType|DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).| 293 +|DataSetID|IDType|DataSetID provides an identifier for a contained data set.| 294 +|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.| 295 +|Source|TextType|Source provides human-readable information about the source of the data.| 301 301 302 302 **BasicHeaderType:** BasicHeaderType defines the most basic header information used in simple message exchanges. 303 303 ... ... @@ -304,7 +304,7 @@ 304 304 Derivation: 305 305 306 306 BaseHeaderType (restriction) 307 - BasicHeaderType302 + BasicHeaderType 308 308 309 309 Content: 310 310 ID, Test, Prepared, Sender, Receiver ... ... @@ -311,12 +311,12 @@ 311 311 312 312 Element Documentation: 313 313 314 -|**Name**|**Type**|**Documentation**| 315 -|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 316 -|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 317 -|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 318 -|Sender|SenderType|Sender is information about the party that is transmitting the message.| 319 -|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 309 +|**Name**|**Type**|**Documentation**| 310 +|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 311 +|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 312 +|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 313 +|Sender|SenderType|Sender is information about the party that is transmitting the message.| 314 +|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.| 320 320 321 321 **PartyType:** PartyType defines the information which is sent about various parties such as senders and receivers of messages. 322 322 ... ... @@ -328,14 +328,14 @@ 328 328 329 329 Attribute Documentation: 330 330 331 -|**Name**|**Type**|**Documentation**| 332 -|id|IDType|The id attribute holds the identification of the party.| 326 +|**Name**|**Type**|**Documentation**| 327 +|id|IDType|The id attribute holds the identification of the party.| 333 333 334 334 Element Documentation: 335 335 336 -|**Name**|**Type**|**Documentation**| 337 -|Name|TextType|Name is a human-readable name of the party.| 338 -|Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.| 331 +|**Name**|**Type**|**Documentation**| 332 +|Name|TextType|Name is a human-readable name of the party.| 333 +|Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.| 339 339 340 340 **SenderType:** SenderType extends the basic party structure to add an optional time zone declaration. 341 341 ... ... @@ -342,7 +342,7 @@ 342 342 Derivation: 343 343 344 344 PartyType (extension) 345 - SenderType340 + SenderType 346 346 347 347 Attributes: 348 348 id ... ... @@ -352,15 +352,15 @@ 352 352 353 353 Attribute Documentation: 354 354 355 -|**Name**|**Type**|**Documentation**| 356 -|id|IDType|The id attribute holds the identification of the party.| 350 +|**Name**|**Type**|**Documentation**| 351 +|id|IDType|The id attribute holds the identification of the party.| 357 357 358 358 Element Documentation: 359 359 360 -|**Name**|**Type**|**Documentation**| 361 -|Name|TextType|Name is a human-readable name of the party.| 362 -|Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.| 363 -|Timezone|TimezoneType|Timezone specifies the time zone of the sender, and if specified can be applied to all un-time zoned time values in the message. In the absence of this, any dates without time zone are implied to be in an indeterminate "local time".| 355 +|**Name**|**Type**|**Documentation**| 356 +|Name|TextType|Name is a human-readable name of the party.| 357 +|Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.| 358 +|Timezone|TimezoneType|Timezone specifies the time zone of the sender, and if specified can be applied to all un-time zoned time values in the message. In the absence of this, any dates without time zone are implied to be in an indeterminate "local time".| 364 364 365 365 **ContactType:** ContactType provides defines the contact information about a party. 366 366 ... ... @@ -369,15 +369,15 @@ 369 369 370 370 Element Documentation: 371 371 372 -|**Name**|**Type**|**Documentation**| 373 -|Name|TextType|Name contains a human-readable name for the contact.| 374 -|Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.| 375 -|Role|TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.| 376 -|Telephone|xs:string|Telephone holds the telephone number for the contact person.| 377 -|Fax|xs:string|Fax holds the fax number for the contact person.| 378 -|X400|xs:string|X400 holds the X.400 address for the contact person.| 379 -|URI|xs:anyURI|URI holds an information URL for the contact person.| 380 -|Email|xs:string|Email holds the email address for the contact person.| 367 +|**Name**|**Type**|**Documentation**| 368 +|Name|TextType|Name contains a human-readable name for the contact.| 369 +|Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.| 370 +|Role|TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.| 371 +|Telephone|xs:string|Telephone holds the telephone number for the contact person.| 372 +|Fax|xs:string|Fax holds the fax number for the contact person.| 373 +|X400|xs:string|X400 holds the X.400 address for the contact person.| 374 +|URI|xs:anyURI|URI holds an information URL for the contact person.| 375 +|Email|xs:string|Email holds the email address for the contact person.| 381 381 382 382 === 2.1.4 Simple Types === 383 383 ... ... @@ -394,9 +394,9 @@ 394 394 395 395 Referenced Namespaces: 396 396 397 -|**Namespace**|**Prefix**| 398 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common| 399 -|http://www.w3.org/2001/XMLSchema|xs| 392 +|**Namespace**|**Prefix**| 393 +|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common| 394 +|http://www.w3.org/2001/XMLSchema|xs| 400 400 401 401 Contents: 402 402 1 Global Element ... ... @@ -416,8 +416,8 @@ 416 416 417 417 Element Documentation: 418 418 419 -|**Name**|**Type**|**Documentation**| 420 -|Message|FooterMessageType|Message contains a single error, information, or warning message. A code is provided along with an optional severity. The text of the message can be expressed in multiple languages.| 414 +|**Name**|**Type**|**Documentation**| 415 +|Message|FooterMessageType|Message contains a single error, information, or warning message. A code is provided along with an optional severity. The text of the message can be expressed in multiple languages.| 421 421 422 422 **FooterMessageType:** FooterMessageType defines the structure of a message that is contained in the footer of a message. It is a status message that have a severity code of Error, Information, or Warning added to it. 423 423 ... ... @@ -424,8 +424,8 @@ 424 424 Derivation: 425 425 426 426 StatusMessageType (restriction) 427 - CodedStatusMessageType (extension)428 - FooterMessageType422 + CodedStatusMessageType (extension) 423 + FooterMessageType 429 429 430 430 Attributes: 431 431 code, severity? ... ... @@ -435,14 +435,14 @@ 435 435 436 436 Attribute Documentation: 437 437 438 -|**Name**|**Type**|**Documentation**| 439 -|code|xs:string|The code attribute holds an optional code identifying the underlying error that generated the message. This should be used if parallel language descriptions of the error are supplied, to distinguish which of the multiple error messages are for the same underlying error.| 440 -|severity|SeverityCodeType| |433 +|**Name**|**Type**|**Documentation**| 434 +|code|xs:string|The code attribute holds an optional code identifying the underlying error that generated the message. This should be used if parallel language descriptions of the error are supplied, to distinguish which of the multiple error messages are for the same underlying error.| 435 +|severity|SeverityCodeType|| 441 441 442 442 Element Documentation: 443 443 444 -|**Name**|**Type**|**Documentation**| 445 -|Text|TextType|Text contains the text of the message, in parallel language values.| 439 +|**Name**|**Type**|**Documentation**| 440 +|Text|TextType|Text contains the text of the message, in parallel language values.| 446 446 447 447 === 2.2.4 Simple Types === 448 448 ... ... @@ -452,7 +452,7 @@ 452 452 453 453 Enumerations: 454 454 455 -|**Value**|**Documentation**| 456 -|Error|Error indicates the status message coresponds to an error.| 457 -|Warning|Warning indicates that the status message corresponds to a warning.| 458 -|Information|Information indicates that the status message corresponds to an informational message.| 450 +|**Value**|**Documentation**| 451 +|Error|Error indicates the status message coresponds to an error.| 452 +|Warning|Warning indicates that the status message corresponds to a warning.| 453 +|Information|Information indicates that the status message corresponds to an informational message.|