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 ... ... @@ -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: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 ... ... @@ -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 ... ... @@ -138,21 +138,20 @@ 138 138 139 139 Element Documentation: 140 140 141 -(% style="width:1029.29px" %) 142 -|**Name**|**Type**|(% style="width:521px" %)**Documentation** 143 -|Header|BasicHeaderType|(% style="width:521px" %) 144 -|SubmitRegistrationsRequest|SubmitRegistrationsRequestType|(% style="width:521px" %)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. 145 -|SubmitRegistrationsResponse|SubmitRegistrationsResponseType|(% style="width:521px" %)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. 146 -|QueryRegistrationRequest|QueryRegistrationRequestType|(% style="width:521px" %)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. 147 -|QueryRegistrationResponse|QueryRegistrationResponseType|(% style="width:521px" %)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. 148 -|SubmitStructureRequest|SubmitStructureRequestType|(% style="width:521px" %)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. 149 -|SubmitStructureResponse|SubmitStructureResponseType|(% style="width:521px" %)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. 150 -|SubmitSubscriptionsRequest|SubmitSubscriptionsRequestType|(% style="width:521px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources. 151 -|SubmitSubscriptionsResponse|SubmitSubscriptionsResponseType|(% style="width:521px" %)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. 152 -|QuerySubscriptionRequest|QuerySubscriptionRequestType|(% style="width:521px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation. 153 -|QuerySubscriptionResponse|QuerySubscriptionResponseType|(% style="width:521px" %)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. 154 -|NotifyRegistryEvent|NotifyRegistryEventType|(% style="width:521px" %)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. 155 -|Footer|FooterType|(% style="width:521px" %)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.| 156 156 157 157 **SubmitStructureRequestType:** SubmitStructureRequestType defines the structure of a registry submit structure request document. 158 158 ... ... @@ -167,10 +167,9 @@ 167 167 168 168 Element Documentation: 169 169 170 -(% style="width:1044.29px" %) 171 -|**Name**|**Type**|(% style="width:624px" %)**Documentation** 172 -|Header|BasicHeaderType|(% style="width:624px" %) 173 -|SubmitStructureRequest|SubmitStructureRequestType|(% style="width:624px" %)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.| 174 174 175 175 **SubmitStructureResponseType:** SubmitStructureResponseType defines the structure of a registry submit registration response document. 176 176 ... ... @@ -185,11 +185,10 @@ 185 185 186 186 Element Documentation: 187 187 188 -(% style="width:1027.29px" %) 189 -|**Name**|**Type**|(% style="width:549px" %)**Documentation** 190 -|Header|BasicHeaderType|(% style="width:549px" %) 191 -|SubmitStructureResponse|SubmitStructureResponseType|(% style="width:549px" %)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. 192 -|Footer|FooterType|(% style="width:549px" %)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.| 193 193 194 194 **ErrorType:** ErrorType describes the structure of an error response. 195 195 ... ... @@ -198,9 +198,8 @@ 198 198 199 199 Element Documentation: 200 200 201 -(% style="width:1039.29px" %) 202 -|**Name**|**Type**|**Documentation** 203 -|ErrorMessage|CodedStatusMessageType|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.| 204 204 205 205 ***BaseHeaderType*:** BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this 206 206 ... ... @@ -209,24 +209,23 @@ 209 209 210 210 Element Documentation: 211 211 212 -(% style="width:1010.29px" %) 213 -|**Name**|**Type**|(% style="width:612px" %)**Documentation** 214 -|ID|IDType|(% style="width:612px" %)ID identifies an identification for the message, assigned by the sender. 215 -|Test|xs:boolean|(% style="width:612px" %)Test indicates whether the message is for test purposes or not. 216 -|Prepared|HeaderTimeType|(% style="width:612px" %)Prepared is the date the message was prepared. 217 -|Sender|SenderType|(% style="width:612px" %)Sender is information about the party that is transmitting the message. 218 -|Receiver|PartyType|(% style="width:612px" %)Receiver is information about the party that is the intended recipient of the message. 219 -|Name|TextType|(% style="width:612px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. 220 -|Structure|*PayloadStructureType*|(% style="width:612px" %)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. 221 -|DataProvider|DataProviderReferenceType|(% style="width:612px" %)DataProvider identifies the provider of the data for a data message. 222 -|MetadataProvider|MetadataProviderReferenceType|(% style="width:612px" %)MetadataProvider identifies the provider of the metadata for a metadata message. 223 -|DataSetAction|ActionType|(% style="width:612px" %)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). 224 -|DataSetID|IDType|(% style="width:612px" %)DataSetID provides an identifier for a contained data set. 225 -|Extracted|xs:dateTime|(% style="width:612px" %)Extracted is a time-stamp from the system rendering the data. 226 -|ReportingBegin|ObservationalTimePeriodType|(% style="width:612px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data). 227 -|ReportingEnd|ObservationalTimePeriodType|(% style="width:612px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data). 228 -|EmbargoDate|xs:dateTime|(% style="width:612px" %)EmbargoDate holds a time period before which the data included in this message is not available. 229 -|Source|TextType|(% style="width:612px" %)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.| 230 230 231 231 **StructureHeaderType:** StructureHeaderType defines the structure for structural metadata messages. 232 232 ... ... @@ -240,15 +240,14 @@ 240 240 241 241 Element Documentation: 242 242 243 -(% style="width:1018.29px" %) 244 -|**Name**|(% style="width:200px" %)**Type**|(% style="width:706px" %)**Documentation** 245 -|ID|(% style="width:200px" %)IDType|(% style="width:706px" %)ID identifies an identification for the message, assigned by the sender. 246 -|Test|(% style="width:200px" %)xs:boolean|(% style="width:706px" %)Test indicates whether the message is for test purposes or not. 247 -|Prepared|(% style="width:200px" %)HeaderTimeType|(% style="width:706px" %)Prepared is the date the message was prepared. 248 -|Sender|(% style="width:200px" %)SenderType|(% style="width:706px" %)Sender is information about the party that is transmitting the message. 249 -|Receiver|(% style="width:200px" %)PartyType|(% style="width:706px" %)Receiver is information about the party that is the intended recipient of the message. 250 -|Name|(% style="width:200px" %)TextType|(% style="width:706px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. 251 -|Source|(% style="width:200px" %)TextType|(% style="width:706px" %)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.| 252 252 253 253 **StructureSpecificDataHeaderType:** StructureSpecificDataHeaderType defines the header structure for a structure specific data message. 254 254 ... ... @@ -262,23 +262,22 @@ 262 262 263 263 Element Documentation: 264 264 265 -(% style="width:1024.29px" %) 266 -|**Name**|**Type**|(% style="width:622px" %)**Documentation** 267 -|ID|IDType|(% style="width:622px" %)ID identifies an identification for the message, assigned by the sender. 268 -|Test|xs:boolean|(% style="width:622px" %)Test indicates whether the message is for test purposes or not. 269 -|Prepared|HeaderTimeType|(% style="width:622px" %)Prepared is the date the message was prepared. 270 -|Sender|SenderType|(% style="width:622px" %)Sender is information about the party that is transmitting the message. 271 -|Receiver|PartyType|(% style="width:622px" %)Receiver is information about the party that is the intended recipient of the message. 272 -|Name|TextType|(% style="width:622px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. 273 -|Structure|StructureSpecificDataStructureType|(% style="width:622px" %)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. 274 -|DataProvider|DataProviderReferenceType|(% style="width:622px" %)DataProvider identifies the provider of the data for a data message. 275 -|DataSetAction|ActionType|(% style="width:622px" %)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). 276 -|DataSetID|IDType|(% style="width:622px" %)DataSetID provides an identifier for a contained data set. 277 -|Extracted|xs:dateTime|(% style="width:622px" %)Extracted is a time-stamp from the system rendering the data. 278 -|ReportingBegin|ObservationalTimePeriodType|(% style="width:622px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data). 279 -|ReportingEnd|ObservationalTimePeriodType|(% style="width:622px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data). 280 -|EmbargoDate|xs:dateTime|(% style="width:622px" %)EmbargoDate holds a time period before which the data included in this message is not available. 281 -|Source|TextType|(% style="width:622px" %)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.| 282 282 283 283 **GenericMetadataHeaderType:** GenericMetadataHeaderType defines the header format for generic reference metadata. 284 284 ... ... @@ -292,20 +292,19 @@ 292 292 293 293 Element Documentation: 294 294 295 -(% style="width:1027.29px" %) 296 -|**Name**|**Type**|(% style="width:678px" %)**Documentation** 297 -|ID|IDType|(% style="width:678px" %)ID identifies an identification for the message, assigned by the sender. 298 -|Test|xs:boolean|(% style="width:678px" %)Test indicates whether the message is for test purposes or not. 299 -|Prepared|HeaderTimeType|(% style="width:678px" %)Prepared is the date the message was prepared. 300 -|Sender|SenderType|(% style="width:678px" %)Sender is information about the party that is transmitting the message. 301 -|Receiver|PartyType|(% style="width:678px" %)Receiver is information about the party that is the intended recipient of the message. 302 -|Name|TextType|(% style="width:678px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. 303 -|Structure|GenericMetadataStructureType|(% style="width:678px" %)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. 304 -|MetadataProvider|MetadataProviderReferenceType|(% style="width:678px" %)MetadataProvider identifies the provider of the metadata for a metadata message. 305 -|DataSetAction|ActionType|(% style="width:678px" %)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). 306 -|DataSetID|IDType|(% style="width:678px" %)DataSetID provides an identifier for a contained data set. 307 -|Extracted|xs:dateTime|(% style="width:678px" %)Extracted is a time-stamp from the system rendering the data. 308 -|Source|TextType|(% style="width:678px" %)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.| 309 309 310 310 **BasicHeaderType:** BasicHeaderType defines the most basic header information used in simple message exchanges. 311 311