Changes for page Part I. Message Namespace
Last modified by Elena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -26,14 +26,14 @@ 26 26 27 27 Referenced Namespaces: 28 28 29 -|**Namespace**|**Prefix**| 30 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common| 31 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|dsd| 32 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer|footer| 33 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic|metadata| 34 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/registry|registry| 35 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/structure|structure| 36 -|http://www.w3.org/2001/XMLSchema|xs| 29 +|**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| 37 37 38 38 Contents: 39 39 7 Global Elements ... ... @@ -66,9 +66,9 @@ 66 66 67 67 Element Documentation: 68 68 69 -|**Name**|**Type**|**Documentation**| 70 -|Header|*BaseHeaderType*| |71 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.| 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.| 72 72 73 73 **StructureType:** StructureType defines the contents of a structure message. The payload is optional since this message may be returned from a web service with only information in the footer. 74 74 ... ... @@ -75,7 +75,7 @@ 75 75 Derivation: 76 76 77 77 MessageType (restriction) 78 - StructureType78 + StructureType 79 79 80 80 Content: 81 81 Header, Structures?, Footer? ... ... @@ -82,17 +82,17 @@ 82 82 83 83 Element Documentation: 84 84 85 -|**Name**|**Type**|**Documentation**| 86 -|Header|StructureHeaderType| |87 -|Structures|StructuresType| |88 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.| 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.| 89 89 90 90 **StructureSpecificDataType:** StructureSpecificDataType defines the structure of the structure specific data message. Note that the data set payload type is abstract, and therefore it will have to be assigned a type in an instance. This type must be derived from the base type referenced. This base type defines a general structure which can be followed to allow for generic processing of the data even if the exact details of the data structure specific format are not known. 91 91 92 92 Derivation: 93 93 94 -MessageType (restriction) 95 - StructureSpecificDataType94 +MessageType (restriction) 95 + StructureSpecificDataType 96 96 97 97 Content: 98 98 Header, DataSet*, Footer? ... ... @@ -99,10 +99,10 @@ 99 99 100 100 Element Documentation: 101 101 102 -|**Name**|**Type**|**Documentation**| 103 -|Header|StructureSpecificDat aHeaderType| |104 -|DataSet|*DataSetType*| |105 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.| 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.| 106 106 107 107 **GenericMetadataType:** GenericMetadataType defines the contents of a generic metadata message. 108 108 ... ... @@ -109,7 +109,7 @@ 109 109 Derivation: 110 110 111 111 MessageType (restriction) 112 - GenericMetadataType112 + GenericMetadataType 113 113 114 114 Content: 115 115 Header, MetadataSet*, Footer? ... ... @@ -116,10 +116,10 @@ 116 116 117 117 Element Documentation: 118 118 119 -|**Name**|**Type**|**Documentation**| 120 -|Header|GenericMetadataHeade rType| |121 -|MetadataSet|MetadataSetType| |122 -|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.| 119 +|**Name**|**Type**|**Documentation**| 120 +|Header|GenericMetadataHeade rType|| 121 +|MetadataSet|MetadataSetType|| 122 +|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.| 123 123 124 124 **RegistryInterfaceType:** This is a type which describes a structure for holding all of the various dedicated registry interface message types. 125 125 ... ... @@ -126,7 +126,7 @@ 126 126 Derivation: 127 127 128 128 MessageType (restriction) 129 - RegistryInterfaceType129 + RegistryInterfaceType 130 130 131 131 Content: 132 132 Header, (SubmitRegistrationsRequest|SubmitRegistrationsResponse|QueryRegistrationRequest|QueryRegistrationResponse|SubmitStructureRequest|SubmitStructureResponse|SubmitSubscriptionsRequest|SubmitSubscriptionsResponse|QuerySubscriptionRequest|QuerySubscriptionResponse|NotifyRegistryEvent)?, Footer? ... ... @@ -133,20 +133,20 @@ 133 133 134 134 Element Documentation: 135 135 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.| 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.| 150 150 151 151 **SubmitStructureRequestType:** SubmitStructureRequestType defines the structure of a registry submit structure request document. 152 152 ... ... @@ -153,8 +153,8 @@ 153 153 Derivation: 154 154 155 155 MessageType (restriction) 156 - RegistryInterfaceType (restriction)157 - SubmitStructureRequestType156 + RegistryInterfaceType (restriction) 157 + SubmitStructureRequestType 158 158 159 159 Content: 160 160 Header, SubmitStructureRequest ... ... @@ -161,9 +161,9 @@ 161 161 162 162 Element Documentation: 163 163 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.| 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.| 167 167 168 168 **SubmitStructureResponseType:** SubmitStructureResponseType defines the structure of a registry submit registration response document. 169 169 ... ... @@ -170,8 +170,8 @@ 170 170 Derivation: 171 171 172 172 MessageType (restriction) 173 - RegistryInterfaceType (restriction)174 - SubmitStructureResponseType173 + RegistryInterfaceType (restriction) 174 + SubmitStructureResponseType 175 175 176 176 Content: 177 177 Header, SubmitStructureResponse, Footer? ... ... @@ -178,10 +178,10 @@ 178 178 179 179 Element Documentation: 180 180 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.| 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.| 185 185 186 186 **ErrorType:** ErrorType describes the structure of an error response. 187 187 ... ... @@ -190,8 +190,8 @@ 190 190 191 191 Element Documentation: 192 192 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.| 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.| 195 195 196 196 ***BaseHeaderType*:** BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this 197 197 ... ... @@ -200,23 +200,23 @@ 200 200 201 201 Element Documentation: 202 202 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.| 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.| 220 220 221 221 **StructureHeaderType:** StructureHeaderType defines the structure for structural metadata messages. 222 222 ... ... @@ -223,7 +223,7 @@ 223 223 Derivation: 224 224 225 225 BaseHeaderType (restriction) 226 - StructureHeaderType226 + StructureHeaderType 227 227 228 228 Content: 229 229 ID, Test, Prepared, Sender, Receiver*, Name*, Source ... ... @@ -230,14 +230,14 @@ 230 230 231 231 Element Documentation: 232 232 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.| 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.| 241 241 242 242 **StructureSpecificDataHeaderType:** StructureSpecificDataHeaderType defines the header structure for a structure specific data message. 243 243 ... ... @@ -244,7 +244,7 @@ 244 244 Derivation: 245 245 246 246 BaseHeaderType (restriction) 247 - StructureSpecificDataHeaderType247 + StructureSpecificDataHeaderType 248 248 249 249 Content: 250 250 ID, Test, Prepared, Sender, Receiver*, Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source ... ... @@ -251,22 +251,22 @@ 251 251 252 252 Element Documentation: 253 253 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.| 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.| 270 270 271 271 **GenericMetadataHeaderType:** GenericMetadataHeaderType defines the header format for generic reference metadata. 272 272 ... ... @@ -273,7 +273,7 @@ 273 273 Derivation: 274 274 275 275 BaseHeaderType (restriction) 276 - GenericMetadataHeaderType276 + GenericMetadataHeaderType 277 277 278 278 Content: 279 279 ID, Test, Prepared, Sender, Receiver*, Name*, Structure+, MetadataProvider?, DataSetAction?, DataSetID*, Extracted?, Source ... ... @@ -280,19 +280,19 @@ 280 280 281 281 Element Documentation: 282 282 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.| 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.| 296 296 297 297 **BasicHeaderType:** BasicHeaderType defines the most basic header information used in simple message exchanges. 298 298 ... ... @@ -299,7 +299,7 @@ 299 299 Derivation: 300 300 301 301 BaseHeaderType (restriction) 302 - BasicHeaderType302 + BasicHeaderType 303 303 304 304 Content: 305 305 ID, Test, Prepared, Sender, Receiver ... ... @@ -306,12 +306,12 @@ 306 306 307 307 Element Documentation: 308 308 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.| 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.| 315 315 316 316 **PartyType:** PartyType defines the information which is sent about various parties such as senders and receivers of messages. 317 317 ... ... @@ -323,14 +323,14 @@ 323 323 324 324 Attribute Documentation: 325 325 326 -|**Name**|**Type**|**Documentation**| 327 -|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.| 328 328 329 329 Element Documentation: 330 330 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.| 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.| 334 334 335 335 **SenderType:** SenderType extends the basic party structure to add an optional time zone declaration. 336 336 ... ... @@ -337,7 +337,7 @@ 337 337 Derivation: 338 338 339 339 PartyType (extension) 340 - SenderType340 + SenderType 341 341 342 342 Attributes: 343 343 id ... ... @@ -347,15 +347,15 @@ 347 347 348 348 Attribute Documentation: 349 349 350 -|**Name**|**Type**|**Documentation**| 351 -|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.| 352 352 353 353 Element Documentation: 354 354 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".| 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".| 359 359 360 360 **ContactType:** ContactType provides defines the contact information about a party. 361 361 ... ... @@ -364,15 +364,15 @@ 364 364 365 365 Element Documentation: 366 366 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.| 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.| 376 376 377 377 === 2.1.4 Simple Types === 378 378 ... ... @@ -389,9 +389,9 @@ 389 389 390 390 Referenced Namespaces: 391 391 392 -|**Namespace**|**Prefix**| 393 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common| 394 -|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| 395 395 396 396 Contents: 397 397 1 Global Element ... ... @@ -411,8 +411,8 @@ 411 411 412 412 Element Documentation: 413 413 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.| 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.| 416 416 417 417 **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. 418 418 ... ... @@ -419,8 +419,8 @@ 419 419 Derivation: 420 420 421 421 StatusMessageType (restriction) 422 - CodedStatusMessageType (extension)423 - FooterMessageType422 + CodedStatusMessageType (extension) 423 + FooterMessageType 424 424 425 425 Attributes: 426 426 code, severity? ... ... @@ -430,14 +430,14 @@ 430 430 431 431 Attribute Documentation: 432 432 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| |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|| 436 436 437 437 Element Documentation: 438 438 439 -|**Name**|**Type**|**Documentation**| 440 -|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.| 441 441 442 442 === 2.2.4 Simple Types === 443 443 ... ... @@ -447,7 +447,7 @@ 447 447 448 448 Enumerations: 449 449 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.| 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.|