Changes for page Part I. Message Namespace

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

From version 3.5
edited by Helena
on 2025/07/02 11:00
Change comment: There is no comment for this version
To version 11.1
edited by Helena
on 2025/07/20 13:14
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Part I. Message
1 +Part I. Message Namespace
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 ===
... ... @@ -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:
... ... @@ -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,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  
... ... @@ -141,17 +141,17 @@
141 141  (% style="width:1029.29px" %)
142 142  |**Name**|**Type**|(% style="width:521px" %)**Documentation**
143 143  |Header|BasicHeaderType|(% style="width:521px" %)
144 -|SubmitRegistrationsRequest|SubmitRegistrationsRequestType|(% style="width:521px" %)SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
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 145  |SubmitRegistrationsResponse|SubmitRegistrationsResponseType|(% style="width:521px" %)SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.
146 -|QueryRegistrationRequest|QueryRegistrationRequestType|(% style="width:521px" %)QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.
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 147  |QueryRegistrationResponse|QueryRegistrationResponseType|(% style="width:521px" %)QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.
148 -|SubmitStructureRequest|SubmitStructureRequestType|(% style="width:521px" %)SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.
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 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 150  |SubmitSubscriptionsRequest|SubmitSubscriptionsRequestType|(% style="width:521px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
151 -|SubmitSubscriptionsResponse|SubmitSubscriptionsResponseType|(% style="width:521px" %)SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.
152 -|QuerySubscriptionRequest|QuerySubscriptionRequestType|(% style="width:521px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
153 -|QuerySubscriptionResponse|QuerySubscriptionResponseType|(% style="width:521px" %)QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.
154 -|NotifyRegistryEvent|NotifyRegistryEventType|(% style="width:521px" %)NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.
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 155  |Footer|FooterType|(% style="width:521px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
156 156  
157 157  **SubmitStructureRequestType:** SubmitStructureRequestType defines the structure of a registry submit structure request document.
... ... @@ -158,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:
... ... @@ -170,14 +170,14 @@
170 170  (% style="width:1044.29px" %)
171 171  |**Name**|**Type**|(% style="width:624px" %)**Documentation**
172 172  |Header|BasicHeaderType|(% style="width:624px" %)
173 -|SubmitStructureRequest|SubmitStructureRequestType|(% style="width:624px" %)SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.
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.
174 174  
175 175  **SubmitStructureResponseType:** SubmitStructureResponseType defines the structure of a registry submit registration response document.
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:
... ... @@ -200,9 +200,9 @@
200 200  
201 201  (% style="width:1039.29px" %)
202 202  |**Name**|**Type**|**Documentation**
203 -|ErrorMessage|CodedStatusMessageType|ErrorMessage contains the error message. It can occur multiple times to communicate message for multiple errors, or to communicate the error message in parallel languages. If both messages for multiple errors and parallel language messages are used, then each error message should be given a code in order to distinguish message for unique errors.
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.
204 204  
205 -***BaseHeaderType*:** BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this
205 +//**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,18 +217,18 @@
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>>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 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 -|DataSetAction|ActionType|(% style="width:612px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
224 -|DataSetID|IDType|(% style="width:612px" %)DataSetID provides an identifier for a contained data set.
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 225  |Extracted|xs:dateTime|(% style="width:612px" %)Extracted is a time-stamp from the system rendering the data.
226 -|ReportingBegin|ObservationalTimePeriodType|(% style="width:612px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
227 -|ReportingEnd|ObservationalTimePeriodType|(% style="width:612px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
228 -|EmbargoDate|xs:dateTime|(% style="width:612px" %)EmbargoDate holds a time period before which the data included in this message is not available.
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 229  |Source|TextType|(% style="width:612px" %)Source provides human-readable information about the source of the data.
230 230  
231 -**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.
232 232  
233 233  Derivation:
234 234  
... ... @@ -270,17 +270,17 @@
270 270  |Sender|SenderType|(% style="width:622px" %)Sender is information about the party that is transmitting the message.
271 271  |Receiver|PartyType|(% style="width:622px" %)Receiver is information about the party that is the intended recipient of the message.
272 272  |Name|TextType|(% style="width:622px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
273 -|Structure|StructureSpecificDataStructureType|(% style="width:622px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
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 274  |DataProvider|DataProviderReferenceType|(% style="width:622px" %)DataProvider identifies the provider of the data for a data message.
275 -|DataSetAction|ActionType|(% style="width:622px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
276 -|DataSetID|IDType|(% style="width:622px" %)DataSetID provides an identifier for a contained data set.
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 277  |Extracted|xs:dateTime|(% style="width:622px" %)Extracted is a time-stamp from the system rendering the data.
278 -|ReportingBegin|ObservationalTimePeriodType|(% style="width:622px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
279 -|ReportingEnd|ObservationalTimePeriodType|(% style="width:622px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
280 -|EmbargoDate|xs:dateTime|(% style="width:622px" %)EmbargoDate holds a time period before which the data included in this message is not available.
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 281  |Source|TextType|(% style="width:622px" %)Source provides human-readable information about the source of the data.
282 282  
283 -**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]].
284 284  
285 285  Derivation:
286 286  
... ... @@ -300,10 +300,10 @@
300 300  |Sender|SenderType|(% style="width:678px" %)Sender is information about the party that is transmitting the message.
301 301  |Receiver|PartyType|(% style="width:678px" %)Receiver is information about the party that is the intended recipient of the message.
302 302  |Name|TextType|(% style="width:678px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
303 -|Structure|GenericMetadataStructureType|(% style="width:678px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
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 304  |MetadataProvider|MetadataProviderReferenceType|(% style="width:678px" %)MetadataProvider identifies the provider of the metadata for a metadata message.
305 -|DataSetAction|ActionType|(% style="width:678px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
306 -|DataSetID|IDType|(% style="width:678px" %)DataSetID provides an identifier for a contained data set.
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 307  |Extracted|xs:dateTime|(% style="width:678px" %)Extracted is a time-stamp from the system rendering the data.
308 308  |Source|TextType|(% style="width:678px" %)Source provides human-readable information about the source of the data.
309 309  
... ... @@ -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  
... ... @@ -332,18 +332,20 @@
332 332  id
333 333  
334 334  Content:
335 -Name*, Contact
336 +Name*, (% style="color:#e74c3c" %)Contact
336 336  
337 -Attribute Documentation:
338 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] 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" %)(% 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.
347 347  
348 348  **SenderType:** SenderType extends the basic party structure to add an optional time zone declaration.
349 349  
... ... @@ -356,21 +356,23 @@
356 356  id
357 357  
358 358  Content:
359 -Name*, Contact*, Timezone?
362 +Name*, (% style="color:#e74c3c" %)Contact(%%)*, Timezone?
360 360  
361 -Attribute Documentation:
364 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] 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 +|(%%)(% 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".
372 372  
373 -**ContactType:** ContactType provides defines the contact information about a party.
378 +**ContactType:** ContactType provides defines the (% style="color:#e74c3c" %)contact(%%) information about a party.
374 374  
375 375  Content:
376 376  Name*, Department*, Role*, (Telephone|Fax|X400|URI|Email)
... ... @@ -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 (% 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.
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,10 +424,11 @@
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>>doc:sdmx:Glossary.Code.WebHome]] is provided along with an optional severity. The text of the message can be expressed in multiple languages.
429 429  
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.
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.
431 431  
432 432  Derivation:
433 433  
... ... @@ -436,21 +436,23 @@
436 436   FooterMessageType
437 437  
438 438  Attributes:
439 -code, severity?
447 +[[code>>doc:sdmx:Glossary.Code.WebHome]], severity?
440 440  
441 441  Content:
442 442  Text+
443 443  
444 -Attribute Documentation:
452 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>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" %)
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