Changes for page Part I. Message Namespace

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

From version 3.2
edited by Helena
on 2025/06/23 17:02
Change comment: There is no comment for this version
To version 3.7
edited by Helena
on 2025/06/23 17:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -178,7 +178,7 @@
178 178  Derivation:
179 179  
180 180  //MessageType// (restriction)
181 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureType
181 + StructureType
182 182  
183 183  Content:
184 184  
... ... @@ -186,10 +186,11 @@
186 186  
187 187  Element Documentation:
188 188  
189 -|**Name**|**Type**|**Documentation**
190 -|Header|StructureHeaderType|
191 -|Structures|str:StructuresType|
192 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
189 +(% style="width:856.294px" %)
190 +|**Name**|(% style="width:210px" %)**Type**|(% style="width:455px" %)**Documentation**
191 +|Header|(% style="width:210px" %)StructureHeaderType|(% style="width:455px" %)
192 +|Structures|(% style="width:210px" %)str:StructuresType|(% style="width:455px" %)
193 +|ftr:Footer|(% style="width:210px" %)ftr:FooterType|(% style="width:455px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
193 193  
194 194  **GenericDataType: **GenericDataType defines the contents of a generic data message.
195 195  
... ... @@ -196,7 +196,7 @@
196 196  Derivation:
197 197  
198 198  //MessageType// (restriction)
199 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataType
200 + GenericDataType
200 200  
201 201  Content:
202 202  
... ... @@ -204,18 +204,19 @@
204 204  
205 205  Element Documentation:
206 206  
207 -|**Name**|**Type**|**Documentation**
208 -|Header|GenericDataHeaderTyp e|
209 -|DataSet|dat:DataSetType|
210 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
208 +(% style="width:847.294px" %)
209 +|**Name**|(% style="width:227px" %)**Type**|(% style="width:450px" %)**Documentation**
210 +|Header|(% style="width:227px" %)GenericDataHeaderTyp e|(% style="width:450px" %)
211 +|DataSet|(% style="width:227px" %)dat:DataSetType|(% style="width:450px" %)
212 +|ftr:Footer|(% style="width:227px" %)ftr:FooterType|(% style="width:450px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
211 211  
212 212  **GenericTimeSeriesDataType: **GenericTimeSeriesDataType defines the structure of the generic time series data message.
213 213  
214 214  Derivation:
215 215  
216 -//MessageType// (restriction)
217 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataType (restriction)
218 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericTimeSeriesDataType
218 +* //MessageType// (restriction)
219 +** GenericDataType (restriction)
220 +*** GenericTimeSeriesDataType
219 219  
220 220  Content:
221 221  
... ... @@ -223,17 +223,18 @@
223 223  
224 224  Element Documentation:
225 225  
226 -|**Name**|**Type**|**Documentation**
227 -|Header|GenericTimeSeriesDat aHeaderType|
228 -|DataSet|dat: TimeSeriesDataSetTyp e|
229 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
228 +(% style="width:856.294px" %)
229 +|**Name**|(% style="width:239px" %)**Type**|(% style="width:458px" %)**Documentation**
230 +|Header|(% style="width:239px" %)GenericTimeSeriesDat aHeaderType|(% style="width:458px" %)
231 +|DataSet|(% style="width:239px" %)dat: TimeSeriesDataSetTyp e|(% style="width:458px" %)
232 +|ftr:Footer|(% style="width:239px" %)ftr:FooterType|(% style="width:458px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
230 230  
231 231  **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.
232 232  
233 233  Derivation:
234 234  
235 -//MessageType// (restriction)
236 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificDataType
238 +* //MessageType// (restriction)
239 +** StructureSpecificDataType
237 237  
238 238  Content:
239 239  
... ... @@ -241,18 +241,19 @@
241 241  
242 242  Element Documentation:
243 243  
244 -|**Name**|**Type**|**Documentation**
245 -|Header|StructureSpecificDat aHeaderType|
246 -|DataSet|//dsd:DataSetType//|
247 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
247 +(% style="width:828.294px" %)
248 +|**Name**|(% style="width:247px" %)**Type**|(% style="width:420px" %)**Documentation**
249 +|Header|(% style="width:247px" %)StructureSpecificDat aHeaderType|(% style="width:420px" %)
250 +|DataSet|(% style="width:247px" %)//dsd:DataSetType//|(% style="width:420px" %)
251 +|ftr:Footer|(% style="width:247px" %)ftr:FooterType|(% style="width:420px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
248 248  
249 249  **StructureSpecificTimeSeriesDataType: **StructureSpecificTimeSeriesDataType defines the structure of the structure specific time series data message.
250 250  
251 251  Derivation:
252 252  
253 -//MessageType// (restriction)
254 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificDataType (restriction)
255 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificTimeSeriesDataType
257 +* //MessageType// (restriction)
258 +** StructureSpecificDataType (restriction)
259 +*** StructureSpecificTimeSeriesDataType
256 256  
257 257  Content:
258 258  
... ... @@ -260,17 +260,18 @@
260 260  
261 261  Element Documentation:
262 262  
263 -|**Name**|**Type**|**Documentation**
264 -|Header|StructureSpecificTim eSeriesDataHeaderTyp e|
265 -|DataSet|//dsd: TimeSeriesDataSetTyp e//|
266 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
267 +(% style="width:839.294px" %)
268 +|**Name**|(% style="width:256px" %)**Type**|(% style="width:434px" %)**Documentation**
269 +|Header|(% style="width:256px" %)StructureSpecificTim eSeriesDataHeaderTyp e|(% style="width:434px" %)
270 +|DataSet|(% style="width:256px" %)//dsd: TimeSeriesDataSetTyp e//|(% style="width:434px" %)
271 +|ftr:Footer|(% style="width:256px" %)ftr:FooterType|(% style="width:434px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
267 267  
268 268  **GenericMetadataType: **GenericMetadataType defines the contents of a generic metadata message.
269 269  
270 270  Derivation:
271 271  
272 -//MessageType// (restriction)
273 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericMetadataType
277 +* //MessageType// (restriction)
278 +** GenericMetadataType
274 274  
275 275  Content:
276 276  
... ... @@ -278,17 +278,18 @@
278 278  
279 279  Element Documentation:
280 280  
281 -|**Name**|**Type**|**Documentation**
282 -|Header|GenericMetadataHeade rType|
283 -|MetadataSet|rep:MetadataSetType|
284 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
286 +(% style="width:836.294px" %)
287 +|(% style="width:181px" %)**Name**|(% style="width:225px" %)**Type**|(% style="width:427px" %)**Documentation**
288 +|(% style="width:181px" %)Header|(% style="width:225px" %)GenericMetadataHeade rType|(% style="width:427px" %)
289 +|(% style="width:181px" %)MetadataSet|(% style="width:225px" %)rep:MetadataSetType|(% style="width:427px" %)
290 +|(% style="width:181px" %)ftr:Footer|(% style="width:225px" %)ftr:FooterType|(% style="width:427px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
285 285  
286 286  **StructureSpecificMetadataType: **StructureSpecificMetadataType defines the structure of a structure specific metadata message. Note that the metadata 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.
287 287  
288 288  Derivation:
289 289  
290 -//MessageType// (restriction)
291 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificMetadataType
296 +* //MessageType// (restriction)
297 +** StructureSpecificMetadataType
292 292  
293 293  Content:
294 294  
... ... @@ -296,17 +296,18 @@
296 296  
297 297  Element Documentation:
298 298  
299 -|**Name**|**Type**|**Documentation**
300 -|Header|StructureSpecificMet adataHeaderType|
301 -|MetadataSet|//msd:MetadataSetType//|
302 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
305 +(% style="width:841.294px" %)
306 +|(% style="width:160px" %)**Name**|(% style="width:250px" %)**Type**|(% style="width:428px" %)**Documentation**
307 +|(% style="width:160px" %)Header|(% style="width:250px" %)StructureSpecificMet adataHeaderType|(% style="width:428px" %)
308 +|(% style="width:160px" %)MetadataSet|(% style="width:250px" %)//msd:MetadataSetType//|(% style="width:428px" %)
309 +|(% style="width:160px" %)ftr:Footer|(% style="width:250px" %)ftr:FooterType|(% style="width:428px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
303 303  
304 304  **RegistryInterfaceType: **This is a type which describes a structure for holding all of the various dedicated registry interface message types.
305 305  
306 306  Derivation:
307 307  
308 -//MessageType// (restriction)
309 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType
315 +* //MessageType// (restriction)
316 +** RegistryInterfaceType
310 310  
311 311  Content:
312 312  
... ... @@ -314,28 +314,29 @@
314 314  
315 315  Element Documentation:
316 316  
317 -|**Name**|**Type**|**Documentation**
318 -|Header|BasicHeaderType|
319 -|SubmitRegistrationsR equest|ref: 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.
320 -|SubmitRegistrationsR esponse|ref: 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.
321 -|QueryRegistrationReq uest|ref: 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.
322 -|QueryRegistrationRes ponse|ref: 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.
323 -|SubmitStructureReque st|ref: 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.
324 -|SubmitStructureRespo nse|ref: 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.
325 -|SubmitSubscriptionsR equest|ref: SubmitSubscriptionsR equestType|SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
326 -|SubmitSubscriptionsR esponse|ref: 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.
327 -|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
328 -|QuerySubscriptionRes ponse|ref: 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.
329 -|NotifyRegistryEvent|ref: 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.
330 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
324 +(% style="width:903.294px" %)
325 +|**Name**|**Type**|(% style="width:441px" %)**Documentation**
326 +|Header|BasicHeaderType|(% style="width:441px" %)
327 +|SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|(% style="width:441px" %)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.
328 +|SubmitRegistrationsR esponse|ref: SubmitRegistrationsR esponseType|(% style="width:441px" %)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.
329 +|QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|(% style="width:441px" %)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.
330 +|QueryRegistrationRes ponse|ref: QueryRegistrationRes ponseType|(% style="width:441px" %)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.
331 +|SubmitStructureReque st|ref: SubmitStructureReque stType|(% style="width:441px" %)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.
332 +|SubmitStructureRespo nse|ref: SubmitStructureRespo nseType|(% style="width:441px" %)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.
333 +|SubmitSubscriptionsR equest|ref: SubmitSubscriptionsR equestType|(% style="width:441px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
334 +|SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|(% style="width:441px" %)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.
335 +|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|(% style="width:441px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
336 +|QuerySubscriptionRes ponse|ref: QuerySubscriptionRes ponseType|(% style="width:441px" %)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.
337 +|NotifyRegistryEvent|ref: NotifyRegistryEventT ype|(% style="width:441px" %)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.
338 +|ftr:Footer|ftr:FooterType|(% style="width:441px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
331 331  
332 332  **SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the structure of a registry submit registration requests document.
333 333  
334 334  Derivation:
335 335  
336 -//MessageType// (restriction)
337 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
338 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitRegistrationsRequestType
344 +* //MessageType// (restriction)
345 +** RegistryInterfaceType (restriction)
346 +*** SubmitRegistrationsRequestType
339 339  
340 340  Content:
341 341