Changes for page Part I. Message Namespace

Last modified by Elena on 2025/09/10 11:19

From version 3.4
edited by Helena
on 2025/07/02 10:55
Change comment: There is no comment for this version
To version 5.1
edited by Helena
on 2025/07/03 10:54
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -37,8 +37,8 @@
37 37  |(% style="width:610px" %)http://www.w3.org/2001/XMLSchema|(% style="width:360px" %)xs
38 38  
39 39  Contents:
40 -7 Global Elements
41 -16 Complex Types
40 +7 Global Elements
41 +16 Complex Types
42 42  1 Simple Type
43 43  
44 44  === 2.1.2 Global Elements ===
... ... @@ -76,7 +76,7 @@
76 76  
77 77  Derivation:
78 78  
79 -MessageType (restriction)
79 +MessageType (restriction)
80 80   StructureType
81 81  
82 82  Content:
... ... @@ -90,7 +90,7 @@
90 90  |Structures|(% style="width:228px" %)StructuresType|(% style="width:589px" %)
91 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.
92 92  
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.
93 +**StructureSpecificDataType:** StructureSpecificDataType defines the structure of the structure specific data message. Note that the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] 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  
... ... @@ -98,7 +98,7 @@
98 98   StructureSpecificDataType
99 99  
100 100  Content:
101 -Header, DataSet*, Footer?
101 +Header, [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]*, Footer?
102 102  
103 103  Element Documentation:
104 104  
... ... @@ -105,7 +105,7 @@
105 105  (% style="width:1005.29px" %)
106 106  |**Name**|(% style="width:269px" %)**Type**|(% style="width:585px" %)**Documentation**
107 107  |Header|(% style="width:269px" %)StructureSpecificDat aHeaderType|(% style="width:585px" %)
108 -|DataSet|(% style="width:269px" %)*DataSetType*|(% style="width:585px" %)
108 +|[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:269px" %)*DataSetType*|(% style="width:585px" %)
109 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.
110 110  
111 111  **GenericMetadataType:** GenericMetadataType defines the contents of a generic metadata message.
... ... @@ -112,7 +112,7 @@
112 112  
113 113  Derivation:
114 114  
115 -MessageType (restriction)
115 +MessageType (restriction) 
116 116   GenericMetadataType
117 117  
118 118  Content:
... ... @@ -130,7 +130,7 @@
130 130  
131 131  Derivation:
132 132  
133 -MessageType (restriction)
133 +MessageType (restriction)
134 134   RegistryInterfaceType
135 135  
136 136  Content:
... ... @@ -138,27 +138,28 @@
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.|
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>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. The [[data source>>doc:sdmx:Glossary.Data source.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]] and [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]]. It specifies whether the result set should include [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]], [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], or both. The search can be characterized by providing (% style="color:#e74c3c" %)constraints(%%) including [[reference periods>>doc:sdmx:Glossary.Reference period.WebHome]], 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, (% 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.
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>>doc:sdmx:Glossary.Subscription.WebHome]] request. It contains information which describes the success or failure of each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, providing any error messages in the event of failure. If successful, it returns the registry URN of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and the subscriber-assigned ID.
152 +|QuerySubscriptionRequest|QuerySubscriptionRequestType|(% style="width:521px" %)QuerySubscriptionRequest is used to query the registry for the [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] of a given organisation.
153 +|QuerySubscriptionResponse|QuerySubscriptionResponseType|(% style="width:521px" %)QuerySubscriptionResponse is sent as a response to a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] query. If the query is successful, the details of all [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]] that triggered the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] 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.
155 155  
156 156  **SubmitStructureRequestType:** SubmitStructureRequestType defines the structure of a registry submit structure request document.
157 157  
158 158  Derivation:
159 159  
160 -MessageType (restriction)
161 - RegistryInterfaceType (restriction)
161 +MessageType (restriction)
162 + RegistryInterfaceType (restriction)
162 162   SubmitStructureRequestType
163 163  
164 164  Content:
... ... @@ -166,16 +166,17 @@
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.|
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, (% 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.
172 172  
173 173  **SubmitStructureResponseType:** SubmitStructureResponseType defines the structure of a registry submit registration response document.
174 174  
175 175  Derivation:
176 176  
177 -MessageType (restriction)
178 - RegistryInterfaceType (restriction)
179 +MessageType (restriction)
180 + RegistryInterfaceType (restriction)
179 179   SubmitStructureResponseType
180 180  
181 181  Content:
... ... @@ -183,10 +183,11 @@
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.|
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.
190 190  
191 191  **ErrorType:** ErrorType describes the structure of an error response.
192 192  
... ... @@ -195,8 +195,9 @@
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.|
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>>doc:sdmx:Glossary.Code.WebHome]] 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,25 +205,26 @@
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.|
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>>doc:sdmx:Glossary.Reference metadata.WebHome]]. 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>>doc:sdmx:Glossary.Dimension.WebHome]] is being used at the observation (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Metadata set.WebHome]] 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>>doc:sdmx:Glossary.Code.WebHome]] provides a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]].
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>>doc:sdmx:Glossary.Time period.WebHome]] covered by the message (in the case of data).
227 +|ReportingEnd|ObservationalTimePeriodType|(% style="width:612px" %)ReportingEnd provides the end of the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] covered by the message (in the case of data).
228 +|EmbargoDate|xs:dateTime|(% style="width:612px" %)EmbargoDate holds a [[time period>>doc:sdmx:Glossary.Time period.WebHome]] 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.
225 225  
226 -**StructureHeaderType:** StructureHeaderType defines the structure for structural metadata messages.
231 +**StructureHeaderType:** StructureHeaderType defines the structure for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] messages.
227 227  
228 228  Derivation:
229 229  
... ... @@ -235,14 +235,15 @@
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.|
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.
246 246  
247 247  **StructureSpecificDataHeaderType:** StructureSpecificDataHeaderType defines the header structure for a structure specific data message.
248 248  
... ... @@ -256,24 +256,25 @@
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.|
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>>doc:sdmx:Glossary.Reference metadata.WebHome]]. 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>>doc:sdmx:Glossary.Dimension.WebHome]] is being used at the observation (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Metadata set.WebHome]] 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>>doc:sdmx:Glossary.Code.WebHome]] provides a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]].
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>>doc:sdmx:Glossary.Time period.WebHome]] covered by the message (in the case of data).
279 +|ReportingEnd|ObservationalTimePeriodType|(% style="width:622px" %)ReportingEnd provides the end of the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] covered by the message (in the case of data).
280 +|EmbargoDate|xs:dateTime|(% style="width:622px" %)EmbargoDate holds a [[time period>>doc:sdmx:Glossary.Time period.WebHome]] 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.
275 275  
276 -**GenericMetadataHeaderType:** GenericMetadataHeaderType defines the header format for generic reference metadata.
283 +**GenericMetadataHeaderType:** GenericMetadataHeaderType defines the header format for generic [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]].
277 277  
278 278  Derivation:
279 279  
... ... @@ -285,19 +285,20 @@
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.|
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>>doc:sdmx:Glossary.Reference metadata.WebHome]]. 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>>doc:sdmx:Glossary.Dimension.WebHome]] is being used at the observation (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Metadata set.WebHome]] 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>>doc:sdmx:Glossary.Code.WebHome]] provides a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]].
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.
301 301  
302 302  **BasicHeaderType:** BasicHeaderType defines the most basic header information used in simple message exchanges.
303 303  
... ... @@ -311,12 +311,13 @@
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.|
322 +(% style="width:1002.29px" %)
323 +|**Name**|**Type**|**Documentation**
324 +|ID|IDType|ID identifies an identification for the message, assigned by the sender.
325 +|Test|xs:boolean|Test indicates whether the message is for test purposes or not.
326 +|Prepared|HeaderTimeType|Prepared is the date the message was prepared.
327 +|Sender|SenderType|Sender is information about the party that is transmitting the message.
328 +|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  
... ... @@ -324,18 +324,20 @@
324 324  id
325 325  
326 326  Content:
327 -Name*, Contact
336 +Name*, (% style="color:#e74c3c" %)Contact
328 328  
329 -Attribute Documentation:
338 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
330 330  
331 -|**Name**|**Type**|**Documentation**|
332 -|id|IDType|The id attribute holds the identification of the party.|
340 +(% style="width:973.294px" %)
341 +|**Name**|**Type**|**Documentation**
342 +|id|IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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.|
346 +(% style="width:975.294px" %)
347 +|(% style="width:114px" %)**Name**|(% style="width:132px" %)**Type**|(% style="width:727px" %)**Documentation**
348 +|(% style="width:114px" %)Name|(% style="width:132px" %)TextType|(% style="width:727px" %)Name is a human-readable name of the party.
349 +|(% style="width:114px" %)(% style="color:#e74c3c" %)Contact|(% style="width:132px" %)ContactType|(% style="width:727px" %)(% style="color:#e74c3c" %)Contact(%%) provides (% style="color:#e74c3c" %)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  
... ... @@ -348,21 +348,23 @@
348 348  id
349 349  
350 350  Content:
351 -Name*, Contact*, Timezone?
362 +Name*, (% style="color:#e74c3c" %)Contact(%%)*, Timezone?
352 352  
353 -Attribute Documentation:
364 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
354 354  
355 -|**Name**|**Type**|**Documentation**|
356 -|id|IDType|The id attribute holds the identification of the party.|
366 +(% style="width:1000.29px" %)
367 +|**Name**|**Type**|**Documentation**
368 +|id|IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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".|
372 +(% style="width:1003.29px" %)
373 +|**Name**|**Type**|**Documentation**
374 +|Name|TextType|Name is a human-readable name of the party.
375 +|(%%)(% style="color:#e74c3c" %)Contact|ContactType|(%%)(% style="color:#e74c3c" %)Contact(%%) provides (% style="color:#e74c3c" %)contact(%%) information for the party in regard to the transmission of the message.
376 +|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 -**ContactType:** ContactType provides defines the contact information about a party.
378 +**ContactType:** ContactType provides defines the (% style="color:#e74c3c" %)contact(%%) information about a party.
366 366  
367 367  Content:
368 368  Name*, Department*, Role*, (Telephone|Fax|X400|URI|Email)
... ... @@ -369,15 +369,16 @@
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.|
385 +(% style="width:1002.29px" %)
386 +|**Name**|**Type**|**Documentation**
387 +|Name|TextType|Name contains a human-readable name for the (% style="color:#e74c3c" %)contact(%%).
388 +|Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the (% style="color:#e74c3c" %)contact(%%) person works.
389 +|Role|TextType|Role is the responsibility of the (% style="color:#e74c3c" %)contact(%%) person with respect to the object for which this person is the (% style="color:#e74c3c" %)contact(%%).
390 +|Telephone|xs:string|Telephone holds the [[telephone number>>doc:sdmx:Glossary.Contact phone number.WebHome]] for the (% style="color:#e74c3c" %)contact(%%) person.
391 +|Fax|xs:string|Fax holds the fax number for the (% style="color:#e74c3c" %)contact(%%) person.
392 +|X400|xs:string|X400 holds the X.400 address for the (% style="color:#e74c3c" %)contact(%%) person.
393 +|URI|xs:anyURI|URI holds an information URL for the (% style="color:#e74c3c" %)contact(%%) person.
394 +|Email|xs:string|Email holds the email address for the (% style="color:#e74c3c" %)contact(%%) person.
381 381  
382 382  === 2.1.4 Simple Types ===
383 383  
... ... @@ -394,13 +394,14 @@
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|
411 +(% style="width:970.294px" %)
412 +|(% style="width:495px" %)**Namespace**|(% style="width:472px" %)**Prefix**
413 +|(% style="width:495px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|(% style="width:472px" %)common
414 +|(% style="width:495px" %)http://www.w3.org/2001/XMLSchema|(% style="width:472px" %)xs
400 400  
401 401  Contents:
402 -1 Global Element
403 -2 Complex Types
417 +1 Global Element
418 +2 Complex Types
404 404  1 Simple Type
405 405  
406 406  === 2.2.2 Global Elements ===
... ... @@ -416,10 +416,11 @@
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.|
434 +(% style="width:1005.29px" %)
435 +|**Name**|**Type**|**Documentation**
436 +|Message|FooterMessageType|Message contains a single error, information, or warning message. A [[code>>doc:sdmx:Glossary.Code.WebHome]] is provided along with an optional severity. The text of the message can be expressed in multiple languages.
421 421  
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.
438 +**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>>doc:sdmx:Glossary.Code.WebHome]] of Error, Information, or Warning added to it.
423 423  
424 424  Derivation:
425 425  
... ... @@ -428,21 +428,23 @@
428 428   FooterMessageType
429 429  
430 430  Attributes:
431 -code, severity?
447 +[[code>>doc:sdmx:Glossary.Code.WebHome]], severity?
432 432  
433 433  Content:
434 434  Text+
435 435  
436 -Attribute Documentation:
452 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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| |
454 +(% style="width:1008.29px" %)
455 +|**Name**|**Type**|(% style="width:785px" %)**Documentation**
456 +|[[code>>doc:sdmx:Glossary.Code.WebHome]]|xs:string|(% style="width:785px" %)The [[code>>doc:sdmx:Glossary.Code.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds an optional [[code>>doc:sdmx:Glossary.Code.WebHome]] 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.
457 +|severity|SeverityCodeType|(% style="width:785px" %)
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.|
461 +(% style="width:1015.29px" %)
462 +|**Name**|**Type**|(% style="width:542px" %)**Documentation**
463 +|Text|TextType|(% style="width:542px" %)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,8 @@
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.|
473 +(% style="width:1026.29px" %)
474 +|**Value**|**Documentation**
475 +|Error|Error indicates the status message coresponds to an error.
476 +|Warning|Warning indicates that the status message corresponds to a warning.
477 +|Information|Information indicates that the status message corresponds to an informational message.
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,1 +1,1 @@
1 -1
1 +7