Changes for page Part I. Message Namespace
Last modified by Helena K. on 2026/06/09 12:28
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Objects (0 modified, 1 added, 1 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -Part I. Message 1 +Part I. Message Namespace - Content
-
... ... @@ -4,11 +4,11 @@ 4 4 5 5 = 1 Introduction = 6 6 7 -At the core of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] XML messages are the message namespaces. These namespaces define the general structure of all messages and define the specific messages that are available for exchange in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. 7 +At the core of the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] XML messages are the message namespaces. These namespaces define the general structure of all messages and define the specific messages that are available for exchange in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]]. 8 8 9 -There are two namespaces associated with the messages. The main namespace schema which defines every message in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message. Associated with this is another sub-namespace, http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer. This namespace defines footer (% style="color:#e74c3c" %)level(%%)information that is available in messages which might require non-standard payload information to be transmitted.9 +There are two namespaces associated with the messages. The main namespace schema which defines every message in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] is http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message. Associated with this is another sub-namespace, http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer. This namespace defines footer level information that is available in messages which might require non-standard payload information to be transmitted. 10 10 11 -In general, every message in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] follows common format of: 11 +In general, every message in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] follows common format of: 12 12 13 13 * Header 14 14 * Payload (0..n) ... ... @@ -37,21 +37,21 @@ 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 === 45 45 46 -**Structure (StructureType):** Structure is a message that contains [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]].It may contain any of the following; categorisations,[[category schemes>>doc:sdmx:Glossary.Category scheme.WebHome]],[[code lists>>doc:sdmx:Glossary.Code list.WebHome]],(% style="color:#e74c3c" %)concepts(%%)([[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]]), data and metadata(% style="color:#e74c3c" %)constraints(%%),[[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]],[[hierarchical code lists>>doc:sdmx:Glossary.Hierarchical code list.WebHome]],[[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]],[[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], organisation schemes, processes,[[reporting taxonomies>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]], structure(% style="color:#e74c3c" %)maps(%%),[[representation>>doc:sdmx:Glossary.Representation.WebHome]](% style="color:#e74c3c" %)maps(%%),.46 +**Structure (StructureType):** Structure is a message that contains structural metadata. It may contain any of the following; categorisations, category schemes, code lists, concepts (concept schemes), data and metadata constraints, data flows, hierarchical code lists, metadata flows, metadata structure definitions, organisation schemes, processes, reporting taxonomies, structure maps, representation maps. 47 47 48 -**StructureSpecificData (StructureSpecificDataType):** StructureSpecificData is used to convey data structure specific according to [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].The payload of this message (i.e. the[[data sets>>doc:sdmx:Glossary.Data set.WebHome]]) will be based on XML schemas which are specific to the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]and the orientation (i.e. the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]) of the data.48 +**StructureSpecificData (StructureSpecificDataType):** StructureSpecificData is used to convey data structure specific according to data structure definition. The payload of this message (i.e. the data sets) will be based on XML schemas which are specific to the data structure definition and the orientation (i.e. the observation dimension) of the data. 49 49 50 50 **GenericMetadata (GenericMetadataType):** GenericMetadata contains reported metadata in a format which supports any metadata structure definition. 51 51 52 -**RegistryInterface (RegistryInterfaceType):** RegistryInterface is used to conduct all interactions with the [[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]Services.52 +**RegistryInterface (RegistryInterfaceType):** RegistryInterface is used to conduct all interactions with the SDMX Registry Services. 53 53 54 -**SubmitStructureRequest (SubmitStructureRequestType):** SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, (% style="color:#e74c3c" %)concepts(%%)and[[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]],[[code lists>>doc:sdmx:Glossary.Code list.WebHome]], etc.) to be submitted may be communicated in-line or be supplied in a referenced[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]Structure messages external to the registry. A response will indicate status and contain any relevant error information.54 +**SubmitStructureRequest (SubmitStructureRequestType):** SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information. 55 55 56 56 **SubmitStructureResponse (SubmitStructureResponseType):** SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant. 57 57 ... ... @@ -59,17 +59,17 @@ 59 59 60 60 === 2.1.3 Complex Types === 61 61 62 -** *MessageType:** MessageType is an abstract type which is used by all of the messages, to allow inheritance of common features. Every message consists of a mandatory header, followed by optional payload (which may occur multiple times), and finally an optional footer section for conveying error, warning, and informational messages.62 +//**MessageType:**// MessageType is an abstract type which is used by all of the messages, to allow inheritance of common features. Every message consists of a mandatory header, followed by optional payload (which may occur multiple times), and finally an optional footer section for conveying error, warning, and informational messages. 63 63 64 64 Content: 65 65 66 -Header, {any element with namespace of http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message} *, Footer?66 +Header, {any element with namespace of http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/message}, Footer? 67 67 68 68 Element Documentation: 69 69 70 70 (% style="width:1007.29px" %) 71 71 |**Name**|(% style="width:192px" %)**Type**|(% style="width:662px" %)**Documentation** 72 -|Header|(% style="width:192px" %) *BaseHeaderType*|(% style="width:662px" %)72 +|Header|(% style="width:192px" %)//BaseHeaderType//|(% style="width:662px" %) 73 73 |Footer|(% style="width:192px" %)FooterType|(% style="width:662px" %)Footer is used to communicate information such as error and warnings after the payload of a message. 74 74 75 75 **StructureType:** StructureType defines the contents of a structure message. The payload is optional since this message may be returned from a web service with only information in the footer. ... ... @@ -76,7 +76,7 @@ 76 76 77 77 Derivation: 78 78 79 -MessageType (restriction) 79 +MessageType (restriction) 80 80 StructureType 81 81 82 82 Content: ... ... @@ -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|(% 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,11 +130,11 @@ 130 130 131 131 Derivation: 132 132 133 -MessageType (restriction) 133 +MessageType (restriction) 134 134 RegistryInterfaceType 135 135 136 136 Content: 137 -Header, (SubmitRegistrationsRequest|SubmitRegistrationsResponse|QueryRegistrationRequest|QueryRegistrationResponse|SubmitStructureRequest|SubmitStructureResponse|SubmitSubscriptionsRequest|SubmitSubscriptionsResponse|QuerySubscriptionRequest|QuerySubscriptionResponse|NotifyRegistryEvent)?, Footer? 137 +Header, (SubmitRegistrationsRequest | SubmitRegistrationsResponse | QueryRegistrationRequest | QueryRegistrationResponse | SubmitStructureRequest | SubmitStructureResponse | SubmitSubscriptionsRequest | SubmitSubscriptionsResponse | QuerySubscriptionRequest | QuerySubscriptionResponse | NotifyRegistryEvent)?, Footer? 138 138 139 139 Element Documentation: 140 140 ... ... @@ -158,8 +158,8 @@ 158 158 159 159 Derivation: 160 160 161 -MessageType (restriction) 162 - RegistryInterfaceType (restriction) 161 +MessageType (restriction) 162 + RegistryInterfaceType (restriction) 163 163 SubmitStructureRequestType 164 164 165 165 Content: ... ... @@ -176,8 +176,8 @@ 176 176 177 177 Derivation: 178 178 179 -MessageType (restriction) 180 - RegistryInterfaceType (restriction) 179 +MessageType (restriction) 180 + RegistryInterfaceType (restriction) 181 181 SubmitStructureResponseType 182 182 183 183 Content: ... ... @@ -202,7 +202,7 @@ 202 202 |**Name**|**Type**|**Documentation** 203 203 |ErrorMessage|CodedStatusMessageType|ErrorMessage contains the error message. It can occur multiple times to communicate message for multiple errors, or to communicate the error message in parallel languages. If both messages for multiple errors and parallel language messages are used, then each error message should be given a code in order to distinguish message for unique errors. 204 204 205 -** *BaseHeaderType*:** BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this205 +//**BaseHeaderType:**// BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this 206 206 207 207 Content: 208 208 ID, Test, Prepared, Sender, Receiver*, Name*, Structure*, DataProvider?, MetadataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source ... ... @@ -217,7 +217,7 @@ 217 217 |Sender|SenderType|(% style="width:612px" %)Sender is information about the party that is transmitting the message. 218 218 |Receiver|PartyType|(% style="width:612px" %)Receiver is information about the party that is the intended recipient of the message. 219 219 |Name|TextType|(% style="width:612px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. 220 -|Structure| *PayloadStructureType*|(% style="width:612px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.220 +|Structure|//PayloadStructureType//|(% style="width:612px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly. 221 221 |DataProvider|DataProviderReferenceType|(% style="width:612px" %)DataProvider identifies the provider of the data for a data message. 222 222 |MetadataProvider|MetadataProviderReferenceType|(% style="width:612px" %)MetadataProvider identifies the provider of the metadata for a metadata message. 223 223 |DataSetAction|ActionType|(% style="width:612px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message). ... ... @@ -319,12 +319,13 @@ 319 319 320 320 Element Documentation: 321 321 322 -|**Name**|**Type**|**Documentation**| 323 -|ID|IDType|ID identifies an identification for the message, assigned by the sender.| 324 -|Test|xs:boolean|Test indicates whether the message is for test purposes or not.| 325 -|Prepared|HeaderTimeType|Prepared is the date the message was prepared.| 326 -|Sender|SenderType|Sender is information about the party that is transmitting the message.| 327 -|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. 328 328 329 329 **PartyType:** PartyType defines the information which is sent about various parties such as senders and receivers of messages. 330 330 ... ... @@ -336,14 +336,16 @@ 336 336 337 337 Attribute Documentation: 338 338 339 -|**Name**|**Type**|**Documentation**| 340 -|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 holds the identification of the party. 341 341 342 342 Element Documentation: 343 343 344 -|**Name**|**Type**|**Documentation**| 345 -|Name|TextType|Name is a human-readable name of the party.| 346 -|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" %)Contact|(% style="width:132px" %)ContactType|(% style="width:727px" %)Contact provides contact information for the party in regard to the transmission of the message. 347 347 348 348 **SenderType:** SenderType extends the basic party structure to add an optional time zone declaration. 349 349 ... ... @@ -360,15 +360,17 @@ 360 360 361 361 Attribute Documentation: 362 362 363 -|**Name**|**Type**|**Documentation**| 364 -|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 holds the identification of the party. 365 365 366 366 Element Documentation: 367 367 368 -|**Name**|**Type**|**Documentation**| 369 -|Name|TextType|Name is a human-readable name of the party.| 370 -|Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.| 371 -|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 +|Contact|ContactType|Contact provides 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". 372 372 373 373 **ContactType:** ContactType provides defines the contact information about a party. 374 374 ... ... @@ -377,15 +377,16 @@ 377 377 378 378 Element Documentation: 379 379 380 -|**Name**|**Type**|**Documentation**| 381 -|Name|TextType|Name contains a human-readable name for the contact.| 382 -|Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.| 383 -|Role|TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.| 384 -|Telephone|xs:string|Telephone holds the telephone number for the contact person.| 385 -|Fax|xs:string|Fax holds the fax number for the contact person.| 386 -|X400|xs:string|X400 holds the X.400 address for the contact person.| 387 -|URI|xs:anyURI|URI holds an information URL for the contact person.| 388 -|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 contact. 388 +|Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works. 389 +|Role|TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact. 390 +|Telephone|xs:string|Telephone holds the telephone number for the contact person. 391 +|Fax|xs:string|Fax holds the fax number for the contact person. 392 +|X400|xs:string|X400 holds the X.400 address for the contact person. 393 +|URI|xs:anyURI|URI holds an information URL for the contact person. 394 +|Email|xs:string|Email holds the email address for the contact person. 389 389 390 390 === 2.1.4 Simple Types === 391 391 ... ... @@ -402,13 +402,14 @@ 402 402 403 403 Referenced Namespaces: 404 404 405 -|**Namespace**|**Prefix**| 406 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common| 407 -|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 408 408 409 409 Contents: 410 -1 Global Element 411 -2 Complex Types 417 +1 Global Element 418 +2 Complex Types 412 412 1 Simple Type 413 413 414 414 === 2.2.2 Global Elements === ... ... @@ -424,8 +424,9 @@ 424 424 425 425 Element Documentation: 426 426 427 -|**Name**|**Type**|**Documentation**| 428 -|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 is provided along with an optional severity. The text of the message can be expressed in multiple languages. 429 429 430 430 **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. 431 431 ... ... @@ -443,14 +443,16 @@ 443 443 444 444 Attribute Documentation: 445 445 446 -|**Name**|**Type**|**Documentation**| 447 -|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.| 448 -|severity|SeverityCodeType| | 454 +(% style="width:1008.29px" %) 455 +|**Name**|**Type**|(% style="width:785px" %)**Documentation** 456 +|code|xs:string|(% style="width:785px" %)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. 457 +|severity|SeverityCodeType|(% style="width:785px" %) 449 449 450 450 Element Documentation: 451 451 452 -|**Name**|**Type**|**Documentation**| 453 -|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. 454 454 455 455 === 2.2.4 Simple Types === 456 456 ... ... @@ -460,7 +460,8 @@ 460 460 461 461 Enumerations: 462 462 463 -|**Value**|**Documentation**| 464 -|Error|Error indicates the status message coresponds to an error.| 465 -|Warning|Warning indicates that the status message corresponds to a warning.| 466 -|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,0 @@ 1 -1
- SKMS.Methodology.Code.MethodologyClass[0]
-
- Index
-
... ... @@ -1,0 +1,1 @@ 1 +2