Wiki source code of Part I. Message
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | **Corrigendum** | ||
| 6 | |||
| 7 | The following problems with the specification dated April 2011 have been rectified as described below. | ||
| 8 | |||
| 9 | **~1. Problem** | ||
| 10 | |||
| 11 | Various parts of the the documentation refer to stand-alone concepts, which were part of earlier draft releases but ultimately excluded from the final release of the standard. | ||
| 12 | |||
| 13 | **Rectification** | ||
| 14 | |||
| 15 | The documentation of the Structure element (line 40) has been updated to remove this reference. | ||
| 16 | |||
| 17 | = 1. Introduction = | ||
| 18 | |||
| 19 | At the core of the SDMX 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. | ||
| 20 | |||
| 21 | There are two namespaces associated with the messages. The main namespace schema which defines every message in SDMX is http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message. Associated with this is another sub-namespace, http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message/footer. This namespace defines footer level information that is available in messages which might require non-standard payload information to be transmitted. | ||
| 22 | |||
| 23 | In general, every message in SDMX follows common format of: | ||
| 24 | |||
| 25 | * Header | ||
| 26 | * Payload (0..n) | ||
| 27 | * Footer (0..1) | ||
| 28 | |||
| 29 | The header and payload elements exist in the message namespace, but the content of the payload is defined in the namespaces that are specific the functionality of the messages. Note that the header follows a common construct, which is then restricted according to the requirements of the message which is using it. | ||
| 30 | |||
| 31 | = 2. Schema Documentation = | ||
| 32 | |||
| 33 | == 2.1 Message Namespace == | ||
| 34 | |||
| 35 | **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message** | ||
| 36 | |||
| 37 | === 2.1.1 Summary === | ||
| 38 | |||
| 39 | Referenced Namespaces: | ||
| 40 | |||
| 41 | (% style="width:788.294px" %) | ||
| 42 | |(% style="width:612px" %)**Namespace**|(% style="width:173px" %)**Prefix** | ||
| 43 | |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:173px" %)com | ||
| 44 | |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/generic|(% style="width:173px" %)dat | ||
| 45 | |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific|(% style="width:173px" %)dsd | ||
| 46 | |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message/footer|(% style="width:173px" %)ftr | ||
| 47 | |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic|(% style="width:173px" %)rep | ||
| 48 | |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific|(% style="width:173px" %)msd | ||
| 49 | |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/query|(% style="width:173px" %)qry | ||
| 50 | |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/registry|(% style="width:173px" %)ref | ||
| 51 | |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure|(% style="width:173px" %)str | ||
| 52 | |(% style="width:612px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:173px" %)xs | ||
| 53 | |||
| 54 | Contents: | ||
| 55 | |||
| 56 | 50 Global Elements | ||
| 57 | 62 Complex Types | ||
| 58 | 1 Simple Type | ||
| 59 | |||
| 60 | === 2.1.2 Global Elements === | ||
| 61 | |||
| 62 | **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), constraints (attachment and content) data flows, hierarchical code lists, metadata flows, metadata structure definitions, organisation schemes, processes, reporting taxonomies, and structure sets. | ||
| 63 | |||
| 64 | **GenericData (GenericDataType): **GenericData is used to convey data in a non data structure specific form. Data sets in this message will be each have a related structure specification in the header, which states the data structure the data conforms to and how the data is organised (i.e. the observation dimension). | ||
| 65 | |||
| 66 | **GenericTimeSeriesData (GenericTimeSeriesDataType): **GenericTimeSeriesData is a special derivation of the generic data message which only allows for time series oriented date (i.e. the observation dimension must be time). Although this is a different message, the content of this message will be exactly the same as a generic data message that specifies time as the observation dimension; therefore no additional processing requirements are necessary. This message is intended to only be used when it is necessary to restrict an exchange to being only time series based data. | ||
| 67 | |||
| 68 | **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. | ||
| 69 | |||
| 70 | **StructureSpecificTimeSeriesData (StructureSpecificTimeSeriesDataType): **StructureSpecificTimeSeriesData is a special derivation of the structure specific data message which only allows for time series oriented date (i.e. the observation dimension must be time). Although this is a different message, the content of this message will be exactly the same as a structure specific data message that specifies time as the observation dimension; therefore no additional processing requirements are necessary. This message is intended to only be used when it is necessary to restrict an exchange to being only time series based data. | ||
| 71 | |||
| 72 | **GenericMetadata (GenericMetadataType): **GenericMetadata contains reported metadata in a format which supports any metadata structure definition. | ||
| 73 | |||
| 74 | **StructureSpecificMetadata (StructureSpecificMetadataType): **StructureSpecificMetadata contains reported metadata in a format which is specific to the metadata structure definitions which define the structure of the metadata being reported. This format allows for validation of the metadata against the intended structure. Note that the each metadata set provided will be based on a metadata structure specific schema. | ||
| 75 | |||
| 76 | **RegistryInterface (RegistryInterfaceType): **RegistryInterface is used to conduct all interactions with the SDMX Registry Services. | ||
| 77 | |||
| 78 | **SubmitRegistrationsRequest (SubmitRegistrationsRequestType): **SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request on 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. | ||
| 79 | |||
| 80 | **SubmitRegistrationsResponse (SubmitRegistrationsResponseType): **SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a registration requests. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service. | ||
| 81 | |||
| 82 | **QueryRegistrationRequest (QueryRegistrationRequestType): **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. | ||
| 83 | |||
| 84 | **QueryRegistrationResponse (QueryRegistrationResponseType): **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. | ||
| 85 | |||
| 86 | **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. | ||
| 87 | |||
| 88 | **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. | ||
| 89 | |||
| 90 | **SubmitSubscriptionsRequest (SubmitSubscriptionsRequestType): **SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources. | ||
| 91 | |||
| 92 | **SubmitSubscriptionsResponse (SubmitSubscriptionsResponseType): **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. | ||
| 93 | |||
| 94 | **QuerySubscriptionRequest (QuerySubscriptionRequestType): **QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation. | ||
| 95 | |||
| 96 | **QuerySubscriptionResponse (QuerySubscriptionResponseType): **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. | ||
| 97 | |||
| 98 | **NotifyRegistryEvent (NotifyRegistryEventType): **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. | ||
| 99 | |||
| 100 | **StructureSpecificDataQuery (DataQueryType): **StructureSpecificDataQuery is used to query SDMX compliant databases or web services for structure specific data. | ||
| 101 | |||
| 102 | **GenericDataQuery (GenericDataQueryType): **GenericDataQuery is used to query SDMX compliant databases or web services for generic data. This is actually a specialization of the structured data query, and therefore can be processed in the same manner. | ||
| 103 | |||
| 104 | **GenericTimeSeriesDataQuery (GenericTimeSeriesDataQueryType): **GenericTimeSeriesDataQuery is used to query SDMX compliant databases or web services for time series only generic data. This is actually a specialization of the generic data query, and therefore can be processed in the same manner. This message is intended to only be used when it is necessary to restrict an exchange to being only time series based data. | ||
| 105 | |||
| 106 | **StructureSpecificTimeSeriesDataQuery (StructureSpecificTimeSeriesDataQueryType): **StructureSpecificTimeSeriesDataQuery is used to query SDMX compliant databases or web services for time series only structure specific data. This is actually a specialization of the structure specific data query, and therefore can be processed in the same manner. This message is intended to only be used when it is necessary to restrict an exchange to being only time series based data. | ||
| 107 | |||
| 108 | **GenericMetadataQuery (MetadataQueryType): **GenericMetadataQuery is used to query SDMX compliant databases or web services for generic format reference metadata. | ||
| 109 | |||
| 110 | **StructureSpecificMetadataQuery (MetadataQueryType): **StructureSpecificMetadataQuery is used to query SDMX compliant databases or web services for metadata structure specific reference metadata. | ||
| 111 | |||
| 112 | **DataSchemaQuery (DataSchemaQueryType): **DataSchemaQuery is used to query SDMX compliant databases or web services for data structure specific schemas for the purpose of validating structured data. | ||
| 113 | |||
| 114 | **MetadataSchemaQuery (MetadataSchemaQueryType): **MetadataSchemaQuery is used to query SDMX compliant databases or web services for metadata structure specific schemas for the purpose of validating structured metadata. | ||
| 115 | |||
| 116 | **StructuresQuery (StructuresQueryType): **StructuresQuery is used to query SDMX compliant databases or web services for any structures based on simple maintainable object properties (e.g. all objects maintained by a maintenance agency). | ||
| 117 | |||
| 118 | **DataflowQuery (DataflowQueryType): **DataflowQuery is used to query SDMX compliant databases or web services for dataflows. | ||
| 119 | |||
| 120 | **MetadataflowQuery (MetadataflowQueryType): **MetadataflowQuery is used to query SDMX compliant databases or web services for metadata flows. | ||
| 121 | |||
| 122 | **DataStructureQuery (DataStructureQueryType): **DataStructureQuery is used to query SDMX compliant databases or web services for data structures definitions. | ||
| 123 | |||
| 124 | **MetadataStructureQuery (MetadataStructureQueryType): **MetadataStructureQuery is used to query SDMX compliant databases or web services for metadata structure definitions. | ||
| 125 | |||
| 126 | **CategorySchemeQuery (CategorySchemeQueryType): **CategorySchemeQuery is used to query SDMX compliant databases or web services for category schemes. | ||
| 127 | |||
| 128 | **ConceptSchemeQuery (ConceptSchemeQueryType): **ConceptSchemeQuery is used to query SDMX compliant databases or web services for concept schemes. | ||
| 129 | |||
| 130 | **CodelistQuery (CodelistQueryType): **CodelistQuery is used to query SDMX compliant databases or web services for codelists. | ||
| 131 | |||
| 132 | **HierarchicalCodelistQuery (HierarchicalCodelistQueryType): **HierarchicalCodelistQuery is used to query SDMX compliant databases or web services for hierarchical codelists. | ||
| 133 | |||
| 134 | **OrganisationSchemeQuery (OrganisationSchemeQueryType): **OrganisationSchemeQuery is used to query SDMX compliant databases or web services for organisation schemes. | ||
| 135 | |||
| 136 | **ReportingTaxonomyQuery (ReportingTaxonomyQueryType): **ReportingTaxonomyQuery is used to query SDMX compliant databases or web services for reporting taxonomies. | ||
| 137 | |||
| 138 | **StructureSetQuery (StructureSetQueryType): **StructureSetQuery is used to query SDMX compliant databases or web services for structure sets. | ||
| 139 | |||
| 140 | **ProcessQuery (ProcessQueryType): **ProcessQuery is used to query SDMX compliant databases or web services for processes. | ||
| 141 | |||
| 142 | **CategorisationQuery (CategorisationQueryType): **CategorisationQuery is used to query SDMX compliant databases or web services for categorisations. | ||
| 143 | |||
| 144 | **ProvisionAgreementQuery (ProvisionAgreementQueryType): **ProvisionAgreementQuery is used to query SDMX compliant databases or web services for provision agreements. | ||
| 145 | |||
| 146 | **ConstraintQuery (ConstraintQueryType): **ConstraintQuery is used to query SDMX compliant databases or web services for constraints. | ||
| 147 | |||
| 148 | **TransformationSchemeQuery (TransformationSchemeQueryType): **TransformationSchemeQuery is used to query SDMX compliant databases or web services for transformation schemes. | ||
| 149 | |||
| 150 | **VtlMappingSchemeQuery (VtlMappingSchemeQueryType): **VtlMappingSchemeQuery is used to query SDMX compliant databases or web services for VTL mapping schemes. | ||
| 151 | |||
| 152 | **NamePersonalisationSchemeQuery (NamePersonalisationSchemeQueryType): **NamePersonalisationSchemeQuery is used to query SDMX compliant databases or web services for name personalisation schemes. | ||
| 153 | |||
| 154 | **RulesetSchemeQuery (RulesetSchemeQueryType): **RulesetSchemeQuery is used to query SDMX compliant databases or web services for ruleset schemes. | ||
| 155 | |||
| 156 | **UserDefinedOperatorSchemeQuery (UserDefinedOperatorSchemeQueryType): **UserDefinedOperatorSchemeQuery is used to query SDMX compliant databases or web services for user defined schemes. | ||
| 157 | |||
| 158 | **CustomTypeSchemeQuery (CustomTypeSchemeQueryType): **CustomTypeSchemeQuery is used to query SDMX compliant databases or web services for custom type schemes. | ||
| 159 | |||
| 160 | **Error (ErrorType): **Error is used to communicate that an error has occurred when responding to a request in an non-registry environment. The content will be a collection of error messages. | ||
| 161 | |||
| 162 | === 2.1.3 Complex Types === | ||
| 163 | |||
| 164 | **//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. | ||
| 165 | |||
| 166 | Content: | ||
| 167 | |||
| 168 | Header, {any element with namespace of http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message}*, ftr:Footer? | ||
| 169 | |||
| 170 | Element Documentation: | ||
| 171 | |||
| 172 | |**Name**|**Type**|**Documentation** | ||
| 173 | |Header|//BaseHeaderType//| | ||
| 174 | |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message. | ||
| 175 | |||
| 176 | **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. | ||
| 177 | |||
| 178 | Derivation: | ||
| 179 | |||
| 180 | * //MessageType// (restriction) | ||
| 181 | ** StructureType | ||
| 182 | |||
| 183 | Content: | ||
| 184 | |||
| 185 | Header, Structures?, ftr:Footer? | ||
| 186 | |||
| 187 | Element Documentation: | ||
| 188 | |||
| 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. | ||
| 194 | |||
| 195 | **GenericDataType: **GenericDataType defines the contents of a generic data message. | ||
| 196 | |||
| 197 | Derivation: | ||
| 198 | |||
| 199 | * //MessageType// (restriction) | ||
| 200 | ** GenericDataType | ||
| 201 | |||
| 202 | Content: | ||
| 203 | |||
| 204 | Header, DataSet*, ftr:Footer? | ||
| 205 | |||
| 206 | Element Documentation: | ||
| 207 | |||
| 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. | ||
| 213 | |||
| 214 | **GenericTimeSeriesDataType: **GenericTimeSeriesDataType defines the structure of the generic time series data message. | ||
| 215 | |||
| 216 | Derivation: | ||
| 217 | |||
| 218 | * //MessageType// (restriction) | ||
| 219 | ** GenericDataType (restriction) | ||
| 220 | *** GenericTimeSeriesDataType | ||
| 221 | |||
| 222 | Content: | ||
| 223 | |||
| 224 | Header, DataSet*, ftr:Footer? | ||
| 225 | |||
| 226 | Element Documentation: | ||
| 227 | |||
| 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. | ||
| 233 | |||
| 234 | **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. | ||
| 235 | |||
| 236 | Derivation: | ||
| 237 | |||
| 238 | * //MessageType// (restriction) | ||
| 239 | ** StructureSpecificDataType | ||
| 240 | |||
| 241 | Content: | ||
| 242 | |||
| 243 | Header, DataSet*, ftr:Footer? | ||
| 244 | |||
| 245 | Element Documentation: | ||
| 246 | |||
| 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. | ||
| 252 | |||
| 253 | **StructureSpecificTimeSeriesDataType: **StructureSpecificTimeSeriesDataType defines the structure of the structure specific time series data message. | ||
| 254 | |||
| 255 | Derivation: | ||
| 256 | |||
| 257 | * //MessageType// (restriction) | ||
| 258 | ** StructureSpecificDataType (restriction) | ||
| 259 | *** StructureSpecificTimeSeriesDataType | ||
| 260 | |||
| 261 | Content: | ||
| 262 | |||
| 263 | Header, DataSet*, ftr:Footer? | ||
| 264 | |||
| 265 | Element Documentation: | ||
| 266 | |||
| 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. | ||
| 272 | |||
| 273 | **GenericMetadataType: **GenericMetadataType defines the contents of a generic metadata message. | ||
| 274 | |||
| 275 | Derivation: | ||
| 276 | |||
| 277 | * //MessageType// (restriction) | ||
| 278 | ** GenericMetadataType | ||
| 279 | |||
| 280 | Content: | ||
| 281 | |||
| 282 | Header, MetadataSet*, ftr:Footer? | ||
| 283 | |||
| 284 | Element Documentation: | ||
| 285 | |||
| 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. | ||
| 291 | |||
| 292 | **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. | ||
| 293 | |||
| 294 | Derivation: | ||
| 295 | |||
| 296 | * //MessageType// (restriction) | ||
| 297 | ** StructureSpecificMetadataType | ||
| 298 | |||
| 299 | Content: | ||
| 300 | |||
| 301 | Header, MetadataSet*, ftr:Footer? | ||
| 302 | |||
| 303 | Element Documentation: | ||
| 304 | |||
| 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. | ||
| 310 | |||
| 311 | **RegistryInterfaceType: **This is a type which describes a structure for holding all of the various dedicated registry interface message types. | ||
| 312 | |||
| 313 | Derivation: | ||
| 314 | |||
| 315 | * //MessageType// (restriction) | ||
| 316 | ** RegistryInterfaceType | ||
| 317 | |||
| 318 | Content: | ||
| 319 | |||
| 320 | Header, (SubmitRegistrationsRequest | SubmitRegistrationsResponse | QueryRegistrationRequest | QueryRegistrationResponse | SubmitStructureRequest | SubmitStructureResponse | SubmitSubscriptionsRequest | SubmitSubscriptionsResponse | QuerySubscriptionRequest | QuerySubscriptionResponse | NotifyRegistryEvent)?, ftr:Footer? | ||
| 321 | |||
| 322 | Element Documentation: | ||
| 323 | |||
| 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. | ||
| 339 | |||
| 340 | **SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the structure of a registry submit registration requests document. | ||
| 341 | |||
| 342 | Derivation: | ||
| 343 | |||
| 344 | * //MessageType// (restriction) | ||
| 345 | ** RegistryInterfaceType (restriction) | ||
| 346 | *** SubmitRegistrationsRequestType | ||
| 347 | |||
| 348 | Content: | ||
| 349 | |||
| 350 | Header, SubmitRegistrationsRequest | ||
| 351 | |||
| 352 | Element Documentation: | ||
| 353 | |||
| 354 | (% style="width:844.294px" %) | ||
| 355 | |**Name**|**Type**|(% style="width:377px" %)**Documentation** | ||
| 356 | |Header|BasicHeaderType|(% style="width:377px" %) | ||
| 357 | |SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|(% style="width:377px" %)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. | ||
| 358 | |||
| 359 | **SubmitRegistrationsResponseType: **SubmitRegistrationsResponseType defines the structure of a registry submit registration response document. | ||
| 360 | |||
| 361 | Derivation: | ||
| 362 | |||
| 363 | * //MessageType// (restriction) | ||
| 364 | ** RegistryInterfaceType (restriction) | ||
| 365 | *** SubmitRegistrationsResponseType | ||
| 366 | |||
| 367 | Content: | ||
| 368 | |||
| 369 | Header, SubmitRegistrationsResponse, ftr:Footer? | ||
| 370 | |||
| 371 | Element Documentation: | ||
| 372 | |||
| 373 | (% style="width:847.294px" %) | ||
| 374 | |**Name**|(% style="width:210px" %)**Type**|(% style="width:408px" %)**Documentation** | ||
| 375 | |Header|(% style="width:210px" %)BasicHeaderType|(% style="width:408px" %) | ||
| 376 | |SubmitRegistrationsR esponse|(% style="width:210px" %)ref: SubmitRegistrationsR esponseType|(% style="width:408px" %)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. | ||
| 377 | |ftr:Footer|(% style="width:210px" %)ftr:FooterType|(% style="width:408px" %)Footer is used to communicate information such as error and warnings after the payload of a message. | ||
| 378 | |||
| 379 | **QueryRegistrationRequestType: **QueryRegistrationRequestType defines the structure of a registry query registration request document. | ||
| 380 | |||
| 381 | Derivation: | ||
| 382 | |||
| 383 | * //MessageType// (restriction) | ||
| 384 | ** RegistryInterfaceType (restriction) | ||
| 385 | *** QueryRegistrationRequestType | ||
| 386 | |||
| 387 | Content: | ||
| 388 | |||
| 389 | Header, QueryRegistrationRequest | ||
| 390 | |||
| 391 | Element Documentation: | ||
| 392 | |||
| 393 | (% style="width:847.294px" %) | ||
| 394 | |**Name**|**Type**|(% style="width:397px" %)**Documentation** | ||
| 395 | |Header|BasicHeaderType|(% style="width:397px" %) | ||
| 396 | |QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|(% style="width:397px" %)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. | ||
| 397 | |||
| 398 | **QueryRegistrationResponseType: **SubmitRegistrationRequestType defines the structure of a registry submit registration response document. | ||
| 399 | |||
| 400 | Derivation: | ||
| 401 | |||
| 402 | * //MessageType// (restriction) | ||
| 403 | ** RegistryInterfaceType (restriction) | ||
| 404 | *** QueryRegistrationResponseType | ||
| 405 | |||
| 406 | Content: | ||
| 407 | |||
| 408 | Header, QueryRegistrationResponse, ftr:Footer? | ||
| 409 | |||
| 410 | Element Documentation: | ||
| 411 | |||
| 412 | (% style="width:856.294px" %) | ||
| 413 | |**Name**|(% style="width:235px" %)**Type**|(% style="width:407px" %)**Documentation** | ||
| 414 | |Header|(% style="width:235px" %)BasicHeaderType|(% style="width:407px" %) | ||
| 415 | |QueryRegistrationRes ponse|(% style="width:235px" %)ref: QueryRegistrationRes ponseType|(% style="width:407px" %)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. | ||
| 416 | |ftr:Footer|(% style="width:235px" %)ftr:FooterType|(% style="width:407px" %)Footer is used to communicate information such as error and warnings after the payload of a message. | ||
| 417 | |||
| 418 | **SubmitStructureRequestType: **SubmitStructureRequestType defines the structure of a registry submit structure request document. | ||
| 419 | |||
| 420 | Derivation: | ||
| 421 | |||
| 422 | * //MessageType// (restriction) | ||
| 423 | ** RegistryInterfaceType (restriction) | ||
| 424 | *** SubmitStructureRequestType | ||
| 425 | |||
| 426 | Content: | ||
| 427 | |||
| 428 | Header, SubmitStructureRequest | ||
| 429 | |||
| 430 | Element Documentation: | ||
| 431 | |||
| 432 | (% style="width:870.294px" %) | ||
| 433 | |**Name**|**Type**|(% style="width:453px" %)**Documentation** | ||
| 434 | |Header|BasicHeaderType|(% style="width:453px" %) | ||
| 435 | |SubmitStructureReque st|ref: SubmitStructureReque stType|(% style="width:453px" %)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. | ||
| 436 | |||
| 437 | **SubmitStructureResponseType: **SubmitStructureResponseType defines the structure of a registry submit registration response document. | ||
| 438 | |||
| 439 | Derivation: | ||
| 440 | |||
| 441 | * //MessageType// (restriction) | ||
| 442 | ** RegistryInterfaceType (restriction) | ||
| 443 | *** SubmitStructureResponseType | ||
| 444 | |||
| 445 | Content: | ||
| 446 | |||
| 447 | Header, SubmitStructureResponse, ftr:Footer? | ||
| 448 | |||
| 449 | Element Documentation: | ||
| 450 | |||
| 451 | (% style="width:835.294px" %) | ||
| 452 | |**Name**|(% style="width:246px" %)**Type**|(% style="width:366px" %)**Documentation** | ||
| 453 | |Header|(% style="width:246px" %)BasicHeaderType|(% style="width:366px" %) | ||
| 454 | |SubmitStructureRespo nse|(% style="width:246px" %)ref: SubmitStructureRespo nseType|(% style="width:366px" %)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. | ||
| 455 | |ftr:Footer|(% style="width:246px" %)ftr:FooterType|(% style="width:366px" %)Footer is used to communicate information such as error and warnings after the payload of a message. | ||
| 456 | |||
| 457 | **SubmitSubscriptionsRequestType: **SubmitSubscriptionsRequestType defines the structure of a registry submit subscription request document. | ||
| 458 | |||
| 459 | Derivation: | ||
| 460 | |||
| 461 | * //MessageType// (restriction) | ||
| 462 | ** RegistryInterfaceType (restriction) | ||
| 463 | *** SubmitSubscriptionsRequestType | ||
| 464 | |||
| 465 | Content: | ||
| 466 | |||
| 467 | Header, SubmitSubscriptionsRequest | ||
| 468 | |||
| 469 | Element Documentation: | ||
| 470 | |||
| 471 | (% style="width:832.294px" %) | ||
| 472 | |**Name**|(% style="width:227px" %)**Type**|(% style="width:319px" %)**Documentation** | ||
| 473 | |Header|(% style="width:227px" %)BasicHeaderType|(% style="width:319px" %) | ||
| 474 | |SubmitSubscriptionsR equest|(% style="width:227px" %)ref: SubmitSubscriptionsR equestType|(% style="width:319px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources. | ||
| 475 | |||
| 476 | **SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType defines the structure of a registry submit subscription response document. | ||
| 477 | |||
| 478 | Derivation: | ||
| 479 | |||
| 480 | * //MessageType// (restriction) | ||
| 481 | ** RegistryInterfaceType (restriction) | ||
| 482 | *** SubmitSubscriptionsResponseType | ||
| 483 | |||
| 484 | Content: | ||
| 485 | |||
| 486 | Header, SubmitSubscriptionsResponse, ftr:Footer? | ||
| 487 | |||
| 488 | Element Documentation: | ||
| 489 | |||
| 490 | (% style="width:843.294px" %) | ||
| 491 | |**Name**|**Type**|(% style="width:362px" %)**Documentation** | ||
| 492 | |Header|BasicHeaderType|(% style="width:362px" %) | ||
| 493 | |SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|(% style="width:362px" %)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. | ||
| 494 | |ftr:Footer|ftr:FooterType|(% style="width:362px" %)Footer is used to communicate information such as error and warnings after the payload of a message. | ||
| 495 | |||
| 496 | **QuerySubscriptionRequestType: **QuerySubscriptionRequestType defines the structure of a registry query subscription request document. | ||
| 497 | |||
| 498 | Derivation: | ||
| 499 | |||
| 500 | * //MessageType// (restriction) | ||
| 501 | ** RegistryInterfaceType (restriction) | ||
| 502 | *** QuerySubscriptionRequestType | ||
| 503 | |||
| 504 | Content: | ||
| 505 | |||
| 506 | Header, QuerySubscriptionRequest | ||
| 507 | |||
| 508 | Element Documentation: | ||
| 509 | |||
| 510 | (% style="width:839.294px" %) | ||
| 511 | |(% style="width:230px" %)**Name**|(% style="width:254px" %)**Type**|(% style="width:352px" %)**Documentation** | ||
| 512 | |(% style="width:230px" %)Header|(% style="width:254px" %)BasicHeaderType|(% style="width:352px" %) | ||
| 513 | |(% style="width:230px" %)QuerySubscriptionReq uest|(% style="width:254px" %)ref: QuerySubscriptionReq uestType|(% style="width:352px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation. | ||
| 514 | |||
| 515 | **QuerySubscriptionResponseType: **QuerySubscriptionResponseType defines the structure of a registry query subscription response document. | ||
| 516 | |||
| 517 | Derivation: | ||
| 518 | |||
| 519 | * //MessageType// (restriction) | ||
| 520 | ** RegistryInterfaceType (restriction) | ||
| 521 | *** QuerySubscriptionResponseType | ||
| 522 | |||
| 523 | Content: | ||
| 524 | |||
| 525 | Header, QuerySubscriptionResponse, ftr:Footer? | ||
| 526 | |||
| 527 | Element Documentation: | ||
| 528 | |||
| 529 | (% style="width:912.294px" %) | ||
| 530 | |**Name**|(% style="width:304px" %)**Type**|(% style="width:336px" %)**Documentation** | ||
| 531 | |Header|(% style="width:304px" %)BasicHeaderType|(% style="width:336px" %) | ||
| 532 | |QuerySubscriptionRes ponse|(% style="width:304px" %)ref: QuerySubscriptionRes ponseType|(% style="width:336px" %)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. | ||
| 533 | |ftr:Footer|(% style="width:304px" %)ftr:FooterType|(% style="width:336px" %)Footer is used to communicate information such as error and warnings after the payload of a message. | ||
| 534 | |||
| 535 | **NotifyRegistryEventType: **NotifyRegistryEventType defines the structure of a registry notification document. | ||
| 536 | |||
| 537 | Derivation: | ||
| 538 | |||
| 539 | * //MessageType// (restriction) | ||
| 540 | ** RegistryInterfaceType (restriction) | ||
| 541 | *** NotifyRegistryEventType | ||
| 542 | |||
| 543 | Content: | ||
| 544 | |||
| 545 | Header, NotifyRegistryEvent | ||
| 546 | |||
| 547 | Element Documentation: | ||
| 548 | |||
| 549 | (% style="width:836.294px" %) | ||
| 550 | |**Name**|**Type**|(% style="width:473px" %)**Documentation** | ||
| 551 | |Header|BasicHeaderType|(% style="width:473px" %) | ||
| 552 | |NotifyRegistryEvent|ref: NotifyRegistryEventT ype|(% style="width:473px" %)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. | ||
| 553 | |||
| 554 | **DataQueryType: **DataQueryType defines the structure of a data query message. | ||
| 555 | |||
| 556 | Derivation: | ||
| 557 | |||
| 558 | * //MessageType// (restriction) | ||
| 559 | ** DataQueryType | ||
| 560 | |||
| 561 | Content: | ||
| 562 | |||
| 563 | Header, Query | ||
| 564 | |||
| 565 | Element Documentation: | ||
| 566 | |||
| 567 | (% style="width:839.294px" %) | ||
| 568 | |(% style="width:244px" %)**Name**|(% style="width:262px" %)**Type**|(% style="width:330px" %)**Documentation** | ||
| 569 | |(% style="width:244px" %)Header|(% style="width:262px" %)BasicHeaderType|(% style="width:330px" %) | ||
| 570 | |(% style="width:244px" %)Query|(% style="width:262px" %)qry:DataQueryType|(% style="width:330px" %) | ||
| 571 | |||
| 572 | **GenericDataQueryType: **DataQueryType defines the structure of a generic data query message. | ||
| 573 | |||
| 574 | Derivation: | ||
| 575 | |||
| 576 | * //MessageType// (restriction) | ||
| 577 | ** DataQueryType (restriction) | ||
| 578 | *** GenericDataQueryType | ||
| 579 | |||
| 580 | Content: | ||
| 581 | |||
| 582 | Header, Query | ||
| 583 | |||
| 584 | Element Documentation: | ||
| 585 | |||
| 586 | (% style="width:833.294px" %) | ||
| 587 | |(% style="width:213px" %)**Name**|(% style="width:243px" %)**Type**|(% style="width:374px" %)**Documentation** | ||
| 588 | |(% style="width:213px" %)Header|(% style="width:243px" %)BasicHeaderType|(% style="width:374px" %) | ||
| 589 | |(% style="width:213px" %)Query|(% style="width:243px" %)qry: GenericDataQueryType|(% style="width:374px" %) | ||
| 590 | |||
| 591 | **GenericTimeSeriesDataQueryType: **GenericTimeSeriesDataQueryType defines the structure of a time series generic data query message. | ||
| 592 | |||
| 593 | Derivation: | ||
| 594 | |||
| 595 | * //MessageType// (restriction) | ||
| 596 | ** DataQueryType (restriction) | ||
| 597 | *** GenericDataQueryType (restriction) | ||
| 598 | **** GenericTimeSeriesDataQueryType | ||
| 599 | |||
| 600 | Content: | ||
| 601 | |||
| 602 | Header, Query | ||
| 603 | |||
| 604 | Element Documentation: | ||
| 605 | |||
| 606 | (% style="width:909.294px" %) | ||
| 607 | |(% style="width:221px" %)**Name**|(% style="width:305px" %)**Type**|(% style="width:380px" %)**Documentation** | ||
| 608 | |(% style="width:221px" %)Header|(% style="width:305px" %)BasicHeaderType|(% style="width:380px" %) | ||
| 609 | |(% style="width:221px" %)Query|(% style="width:305px" %)qry: GenericTimeSeriesDat aQueryType|(% style="width:380px" %) | ||
| 610 | |||
| 611 | **StructureSpecificTimeSeriesDataQueryType: **StructureSpecificTimeSeriesDataQueryType defines the structure of a time series generic data query message. | ||
| 612 | |||
| 613 | Derivation: | ||
| 614 | |||
| 615 | * //MessageType// (restriction) | ||
| 616 | ** DataQueryType (restriction) | ||
| 617 | *** StructureSpecificTimeSeriesDataQueryType | ||
| 618 | |||
| 619 | Content: | ||
| 620 | |||
| 621 | Header, Query | ||
| 622 | |||
| 623 | Element Documentation: | ||
| 624 | |||
| 625 | (% style="width:903.294px" %) | ||
| 626 | |(% style="width:189px" %)**Name**|(% style="width:259px" %)**Type**|(% style="width:452px" %)**Documentation** | ||
| 627 | |(% style="width:189px" %)Header|(% style="width:259px" %)BasicHeaderType|(% style="width:452px" %) | ||
| 628 | |(% style="width:189px" %)Query|(% style="width:259px" %)qry: TimeSeriesDataQueryType|(% style="width:452px" %) | ||
| 629 | |||
| 630 | **MetadataQueryType: **MetadataQueryType defines the structure of a reference metadata query message. | ||
| 631 | |||
| 632 | Derivation: | ||
| 633 | |||
| 634 | * //MessageType// (restriction) | ||
| 635 | ** MetadataQueryType | ||
| 636 | |||
| 637 | Content: | ||
| 638 | |||
| 639 | Header, Query | ||
| 640 | |||
| 641 | Element Documentation: | ||
| 642 | |||
| 643 | (% style="width:858.294px" %) | ||
| 644 | |(% style="width:138px" %)**Name**|(% style="width:246px" %)**Type**|(% style="width:471px" %)**Documentation** | ||
| 645 | |(% style="width:138px" %)Header|(% style="width:246px" %)BasicHeaderType|(% style="width:471px" %) | ||
| 646 | |(% style="width:138px" %)Query|(% style="width:246px" %)qry: MetadataQueryType|(% style="width:471px" %) | ||
| 647 | |||
| 648 | **DataSchemaQueryType: **DataSchemaQueryType defines the structure of a data schema query message. | ||
| 649 | |||
| 650 | Derivation: | ||
| 651 | |||
| 652 | * //MessageType// (restriction) | ||
| 653 | ** DataSchemaQueryType | ||
| 654 | |||
| 655 | Content: | ||
| 656 | |||
| 657 | Header, Query | ||
| 658 | |||
| 659 | Element Documentation: | ||
| 660 | |||
| 661 | (% style="width:895.294px" %) | ||
| 662 | |(% style="width:185px" %)**Name**|(% style="width:294px" %)**Type**|(% style="width:413px" %)**Documentation** | ||
| 663 | |(% style="width:185px" %)Header|(% style="width:294px" %)BasicHeaderType|(% style="width:413px" %) | ||
| 664 | |(% style="width:185px" %)Query|(% style="width:294px" %)qry: DataSchemaQueryType|(% style="width:413px" %) | ||
| 665 | |||
| 666 | **MetadataSchemaQueryType: **MetadataSchemaQueryType defines the structure of a metadata schema query message. | ||
| 667 | |||
| 668 | Derivation: | ||
| 669 | |||
| 670 | * //MessageType// (restriction) | ||
| 671 | ** MetadataSchemaQueryType | ||
| 672 | |||
| 673 | Content: | ||
| 674 | |||
| 675 | Header, Query | ||
| 676 | |||
| 677 | Element Documentation: | ||
| 678 | |||
| 679 | (% style="width:897.294px" %) | ||
| 680 | |(% style="width:166px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:447px" %)**Documentation** | ||
| 681 | |(% style="width:166px" %)Header|(% style="width:281px" %)BasicHeaderType|(% style="width:447px" %) | ||
| 682 | |(% style="width:166px" %)Query|(% style="width:281px" %)qry: MetadataSchemaQueryType|(% style="width:447px" %) | ||
| 683 | |||
| 684 | **StructuresQueryType: **StructuresQueryType defines the structure of a structures query message. | ||
| 685 | |||
| 686 | Derivation: | ||
| 687 | |||
| 688 | * //MessageType// (restriction) | ||
| 689 | ** StructuresQueryType | ||
| 690 | |||
| 691 | Content: | ||
| 692 | |||
| 693 | Header, Query | ||
| 694 | |||
| 695 | Element Documentation: | ||
| 696 | |||
| 697 | (% style="width:886.294px" %) | ||
| 698 | |(% style="width:223px" %)**Name**|(% style="width:255px" %)**Type**|(% style="width:405px" %)**Documentation** | ||
| 699 | |(% style="width:223px" %)Header|(% style="width:255px" %)BasicHeaderType|(% style="width:405px" %) | ||
| 700 | |(% style="width:223px" %)Query|(% style="width:255px" %)qry: StructuresQueryType|(% style="width:405px" %) | ||
| 701 | |||
| 702 | **DataflowQueryType: **DataflowQueryType defines the structure of a dataflow query message. | ||
| 703 | |||
| 704 | Derivation: | ||
| 705 | |||
| 706 | * //MessageType// (restriction) | ||
| 707 | ** DataflowQueryType | ||
| 708 | |||
| 709 | Content: | ||
| 710 | |||
| 711 | Header, Query | ||
| 712 | |||
| 713 | Element Documentation: | ||
| 714 | |||
| 715 | (% style="width:888.294px" %) | ||
| 716 | |(% style="width:176px" %)**Name**|(% style="width:260px" %)**Type**|(% style="width:449px" %)**Documentation** | ||
| 717 | |(% style="width:176px" %)Header|(% style="width:260px" %)BasicHeaderType|(% style="width:449px" %) | ||
| 718 | |(% style="width:176px" %)Query|(% style="width:260px" %)qry: DataflowQueryType|(% style="width:449px" %) | ||
| 719 | |||
| 720 | **MetadataflowQueryType: **MetadataflowQueryType defines the structure of a metadata flow query message. | ||
| 721 | |||
| 722 | Derivation: | ||
| 723 | |||
| 724 | * //MessageType// (restriction) | ||
| 725 | ** MetadataflowQueryType | ||
| 726 | |||
| 727 | Content: | ||
| 728 | |||
| 729 | Header, Query | ||
| 730 | |||
| 731 | Element Documentation: | ||
| 732 | |||
| 733 | (% style="width:886.294px" %) | ||
| 734 | |(% style="width:199px" %)**Name**|(% style="width:296px" %)**Type**|(% style="width:388px" %)**Documentation** | ||
| 735 | |(% style="width:199px" %)Header|(% style="width:296px" %)BasicHeaderType|(% style="width:388px" %) | ||
| 736 | |(% style="width:199px" %)Query|(% style="width:296px" %)qry: MetadataflowQueryType|(% style="width:388px" %) | ||
| 737 | |||
| 738 | **DataStructureQueryType: **KeyFamilyQueryType defines the structure of a data structure query message. | ||
| 739 | |||
| 740 | Derivation: | ||
| 741 | |||
| 742 | * //MessageType// (restriction) | ||
| 743 | ** DataStructureQueryType | ||
| 744 | |||
| 745 | Content: | ||
| 746 | |||
| 747 | Header, Query | ||
| 748 | |||
| 749 | Element Documentation: | ||
| 750 | |||
| 751 | (% style="width:901.294px" %) | ||
| 752 | |(% style="width:202px" %)**Name**|(% style="width:303px" %)**Type**|(% style="width:393px" %)**Documentation** | ||
| 753 | |(% style="width:202px" %)Header|(% style="width:303px" %)BasicHeaderType|(% style="width:393px" %) | ||
| 754 | |(% style="width:202px" %)Query|(% style="width:303px" %)qry: DataStructureQueryType|(% style="width:393px" %) | ||
| 755 | |||
| 756 | **MetadataStructureQueryType: **MetadataStructureQueryType defines the structure of a metadata structure query message. | ||
| 757 | |||
| 758 | Derivation: | ||
| 759 | |||
| 760 | * //MessageType// (restriction) | ||
| 761 | ** MetadataStructureQueryType | ||
| 762 | |||
| 763 | Content: | ||
| 764 | |||
| 765 | Header, Query | ||
| 766 | |||
| 767 | Element Documentation: | ||
| 768 | |||
| 769 | (% style="width:904.294px" %) | ||
| 770 | |(% style="width:226px" %)**Name**|(% style="width:275px" %)**Type**|(% style="width:400px" %)**Documentation** | ||
| 771 | |(% style="width:226px" %)Header|(% style="width:275px" %)BasicHeaderType|(% style="width:400px" %) | ||
| 772 | |(% style="width:226px" %)Query|(% style="width:275px" %)qry: MetadataStructureQueryType|(% style="width:400px" %) | ||
| 773 | |||
| 774 | **CategorySchemeQueryType: **CategorySchemeQueryType defines the structure of a category scheme query message. | ||
| 775 | |||
| 776 | Derivation: | ||
| 777 | |||
| 778 | * //MessageType// (restriction) | ||
| 779 | ** CategorySchemeQueryType | ||
| 780 | |||
| 781 | Content: | ||
| 782 | |||
| 783 | Header, Query | ||
| 784 | |||
| 785 | Element Documentation: | ||
| 786 | |||
| 787 | (% style="width:915.294px" %) | ||
| 788 | |(% style="width:196px" %)**Name**|(% style="width:347px" %)**Type**|(% style="width:369px" %)**Documentation** | ||
| 789 | |(% style="width:196px" %)Header|(% style="width:347px" %)BasicHeaderType|(% style="width:369px" %) | ||
| 790 | |(% style="width:196px" %)Query|(% style="width:347px" %)qry: CategorySchemeQueryType|(% style="width:369px" %) | ||
| 791 | |||
| 792 | **ConceptSchemeQueryType: **ConceptSchemeQueryType defines the structure of a concept scheme query message. | ||
| 793 | |||
| 794 | Derivation: | ||
| 795 | |||
| 796 | * //MessageType// (restriction) | ||
| 797 | ** ConceptSchemeQueryType | ||
| 798 | |||
| 799 | Content: | ||
| 800 | |||
| 801 | Header, Query | ||
| 802 | |||
| 803 | Element Documentation: | ||
| 804 | |||
| 805 | (% style="width:895.294px" %) | ||
| 806 | |(% style="width:222px" %)**Name**|(% style="width:339px" %)**Type**|(% style="width:331px" %)**Documentation** | ||
| 807 | |(% style="width:222px" %)Header|(% style="width:339px" %)BasicHeaderType|(% style="width:331px" %) | ||
| 808 | |(% style="width:222px" %)Query|(% style="width:339px" %)qry: ConceptSchemeQueryType|(% style="width:331px" %) | ||
| 809 | |||
| 810 | **CodelistQueryType: **CodelistQueryType defines the structure of a codelist query message. | ||
| 811 | |||
| 812 | Derivation: | ||
| 813 | |||
| 814 | * //MessageType// (restriction) | ||
| 815 | ** CodelistQueryType | ||
| 816 | |||
| 817 | Content: | ||
| 818 | |||
| 819 | Header, Query | ||
| 820 | |||
| 821 | Element Documentation: | ||
| 822 | |||
| 823 | (% style="width:911.294px" %) | ||
| 824 | |(% style="width:204px" %)**Name**|(% style="width:295px" %)**Type**|(% style="width:409px" %)**Documentation** | ||
| 825 | |(% style="width:204px" %)Header|(% style="width:295px" %)BasicHeaderType|(% style="width:409px" %) | ||
| 826 | |(% style="width:204px" %)Query|(% style="width:295px" %)qry:CodelistQueryType|(% style="width:409px" %) | ||
| 827 | |||
| 828 | **HierarchicalCodelistQueryType: **HierarchicalCodelistQueryType defines the structure of a hierarchical codelist query message. | ||
| 829 | |||
| 830 | Derivation: | ||
| 831 | |||
| 832 | * //MessageType// (restriction) | ||
| 833 | ** HierarchicalCodelistQueryType | ||
| 834 | |||
| 835 | Content: | ||
| 836 | |||
| 837 | Header, Query | ||
| 838 | |||
| 839 | Element Documentation: | ||
| 840 | |||
| 841 | (% style="width:906.294px" %) | ||
| 842 | |(% style="width:191px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:430px" %)**Documentation** | ||
| 843 | |(% style="width:191px" %)Header|(% style="width:281px" %)BasicHeaderType|(% style="width:430px" %) | ||
| 844 | |(% style="width:191px" %)Query|(% style="width:281px" %)qry: HierarchicalCodelist QueryType|(% style="width:430px" %) | ||
| 845 | |||
| 846 | **OrganisationSchemeQueryType: **OrganisationSchemeQueryType defines the structure of an organisation scheme query message. | ||
| 847 | |||
| 848 | Derivation: | ||
| 849 | |||
| 850 | * //MessageType// (restriction) | ||
| 851 | ** OrganisationSchemeQueryType | ||
| 852 | |||
| 853 | Content: | ||
| 854 | |||
| 855 | Header, Query | ||
| 856 | |||
| 857 | Element Documentation: | ||
| 858 | |||
| 859 | (% style="width:891.294px" %) | ||
| 860 | |(% style="width:174px" %)**Name**|(% style="width:292px" %)**Type**|(% style="width:422px" %)**Documentation** | ||
| 861 | |(% style="width:174px" %)Header|(% style="width:292px" %)BasicHeaderType|(% style="width:422px" %) | ||
| 862 | |(% style="width:174px" %)Query|(% style="width:292px" %)qry: OrganisationSchemeQueryType|(% style="width:422px" %) | ||
| 863 | |||
| 864 | **ReportingTaxonomyQueryType: **ReportingTaxonomyQueryType defines the structure of a reporting taxonomy query message. | ||
| 865 | |||
| 866 | Derivation: | ||
| 867 | |||
| 868 | * //MessageType// (restriction) | ||
| 869 | ** ReportingTaxonomyQueryType | ||
| 870 | |||
| 871 | Content: | ||
| 872 | |||
| 873 | Header, Query | ||
| 874 | |||
| 875 | Element Documentation: | ||
| 876 | |||
| 877 | (% style="width:916.294px" %) | ||
| 878 | |(% style="width:162px" %)**Name**|(% style="width:318px" %)**Type**|(% style="width:434px" %)**Documentation** | ||
| 879 | |(% style="width:162px" %)Header|(% style="width:318px" %)BasicHeaderType|(% style="width:434px" %) | ||
| 880 | |(% style="width:162px" %)Query|(% style="width:318px" %)qry: ReportingTaxonomyQueryType|(% style="width:434px" %) | ||
| 881 | |||
| 882 | **StructureSetQueryType: **StructureSetQueryType defines the structure of a structure set query message. | ||
| 883 | |||
| 884 | Derivation: | ||
| 885 | |||
| 886 | * //MessageType// (restriction) | ||
| 887 | ** StructureSetQueryType | ||
| 888 | |||
| 889 | Content: | ||
| 890 | |||
| 891 | Header, Query | ||
| 892 | |||
| 893 | Element Documentation: | ||
| 894 | |||
| 895 | (% style="width:896.294px" %) | ||
| 896 | |(% style="width:182px" %)**Name**|(% style="width:294px" %)**Type**|(% style="width:417px" %)**Documentation** | ||
| 897 | |(% style="width:182px" %)Header|(% style="width:294px" %)BasicHeaderType|(% style="width:417px" %) | ||
| 898 | |(% style="width:182px" %)Query|(% style="width:294px" %)qry: StructureSetQueryType|(% style="width:417px" %) | ||
| 899 | |||
| 900 | **ProcessQueryType: **CategorizationQueryType defines the structure of a categorization query message. | ||
| 901 | |||
| 902 | Derivation: | ||
| 903 | |||
| 904 | * //MessageType// (restriction) | ||
| 905 | ** ProcessQueryType | ||
| 906 | |||
| 907 | Content: | ||
| 908 | |||
| 909 | Header, Query | ||
| 910 | |||
| 911 | Element Documentation: | ||
| 912 | |||
| 913 | (% style="width:907.294px" %) | ||
| 914 | |(% style="width:189px" %)**Name**|(% style="width:394px" %)**Type**|(% style="width:321px" %)**Documentation** | ||
| 915 | |(% style="width:189px" %)Header|(% style="width:394px" %)BasicHeaderType|(% style="width:321px" %) | ||
| 916 | |(% style="width:189px" %)Query|(% style="width:394px" %)qry:ProcessQueryType|(% style="width:321px" %) | ||
| 917 | |||
| 918 | **CategorisationQueryType: **CategorisationQueryType defines the structure of a categorisation query message. | ||
| 919 | |||
| 920 | Derivation: | ||
| 921 | |||
| 922 | * //MessageType// (restriction) | ||
| 923 | ** CategorisationQueryType | ||
| 924 | |||
| 925 | Content: | ||
| 926 | |||
| 927 | Header, Query | ||
| 928 | |||
| 929 | Element Documentation: | ||
| 930 | |||
| 931 | (% style="width:897.294px" %) | ||
| 932 | |(% style="width:230px" %)**Name**|(% style="width:300px" %)**Type**|(% style="width:363px" %)**Documentation** | ||
| 933 | |(% style="width:230px" %)Header|(% style="width:300px" %)BasicHeaderType|(% style="width:363px" %) | ||
| 934 | |(% style="width:230px" %)Query|(% style="width:300px" %)qry: CategorisationQueryType|(% style="width:363px" %) | ||
| 935 | |||
| 936 | **ProvisionAgreementQueryType: **ProvisionAgreementQueryType defines the structure of a provision agreement query message. | ||
| 937 | |||
| 938 | Derivation: | ||
| 939 | |||
| 940 | * //MessageType// (restriction) | ||
| 941 | ** ProvisionAgreementQueryType | ||
| 942 | |||
| 943 | Content: | ||
| 944 | |||
| 945 | Header, Query | ||
| 946 | |||
| 947 | Element Documentation: | ||
| 948 | |||
| 949 | (% style="width:902.294px" %) | ||
| 950 | |(% style="width:142px" %)**Name**|(% style="width:339px" %)**Type**|(% style="width:418px" %)**Documentation** | ||
| 951 | |(% style="width:142px" %)Header|(% style="width:339px" %)BasicHeaderType|(% style="width:418px" %) | ||
| 952 | |(% style="width:142px" %)Query|(% style="width:339px" %)qry: ProvisionAgreementQueryType|(% style="width:418px" %) | ||
| 953 | |||
| 954 | **ConstraintQueryType: **ConstraintQueryType defines the structure of a constraint query message. | ||
| 955 | |||
| 956 | Derivation: | ||
| 957 | |||
| 958 | * //MessageType// (restriction) | ||
| 959 | ** ConstraintQueryType | ||
| 960 | |||
| 961 | Content: | ||
| 962 | |||
| 963 | Header, Query | ||
| 964 | |||
| 965 | Element Documentation: | ||
| 966 | |||
| 967 | (% style="width:902.294px" %) | ||
| 968 | |(% style="width:167px" %)**Name**|(% style="width:287px" %)**Type**|(% style="width:445px" %)**Documentation** | ||
| 969 | |(% style="width:167px" %)Header|(% style="width:287px" %)BasicHeaderType|(% style="width:445px" %) | ||
| 970 | |(% style="width:167px" %)Query|(% style="width:287px" %)qry: ConstraintQueryType|(% style="width:445px" %) | ||
| 971 | |||
| 972 | **TransformationSchemeQueryType: **TransformationSchemeQueryType defines the structure of a transformation scheme query message. | ||
| 973 | |||
| 974 | Derivation: | ||
| 975 | |||
| 976 | * //MessageType// (restriction) | ||
| 977 | ** TransformationSchemeQueryType | ||
| 978 | |||
| 979 | Content: | ||
| 980 | |||
| 981 | Header, Query | ||
| 982 | |||
| 983 | Element Documentation: | ||
| 984 | |||
| 985 | (% style="width:833.294px" %) | ||
| 986 | |(% style="width:165px" %)**Name**|(% style="width:325px" %)**Type**|(% style="width:340px" %)**Documentation** | ||
| 987 | |(% style="width:165px" %)Header|(% style="width:325px" %)BasicHeaderType|(% style="width:340px" %) | ||
| 988 | |(% style="width:165px" %)Query|(% style="width:325px" %)qry: TransformationSchemeQueryType|(% style="width:340px" %) | ||
| 989 | |||
| 990 | **VtlMappingSchemeQueryType: **VtlMappingSchemeQueryType defines the structure of a VTL mappings scheme query message. | ||
| 991 | |||
| 992 | Derivation: | ||
| 993 | |||
| 994 | * //MessageType// (restriction) | ||
| 995 | ** VtlMappingSchemeQueryType | ||
| 996 | |||
| 997 | Content: | ||
| 998 | |||
| 999 | Header, Query | ||
| 1000 | |||
| 1001 | Element Documentation: | ||
| 1002 | |||
| 1003 | (% style="width:843.294px" %) | ||
| 1004 | |(% style="width:164px" %)**Name**|(% style="width:303px" %)**Type**|(% style="width:373px" %)**Documentation** | ||
| 1005 | |(% style="width:164px" %)Header|(% style="width:303px" %)BasicHeaderType|(% style="width:373px" %) | ||
| 1006 | |(% style="width:164px" %)Query|(% style="width:303px" %)qry: VtlMappingSchemeQueryType|(% style="width:373px" %) | ||
| 1007 | |||
| 1008 | **NamePersonalisationSchemeQueryType: **NamePersonalisationSchemeQueryType defines the structure of a name personalisation scheme query message. | ||
| 1009 | |||
| 1010 | Derivation: | ||
| 1011 | |||
| 1012 | * //MessageType// (restriction) | ||
| 1013 | ** NamePersonalisationSchemeQueryType | ||
| 1014 | |||
| 1015 | Content: | ||
| 1016 | |||
| 1017 | Header, Query | ||
| 1018 | |||
| 1019 | Element Documentation: | ||
| 1020 | |||
| 1021 | (% style="width:895.294px" %) | ||
| 1022 | |(% style="width:186px" %)**Name**|(% style="width:363px" %)**Type**|(% style="width:343px" %)**Documentation** | ||
| 1023 | |(% style="width:186px" %)Header|(% style="width:363px" %)BasicHeaderType|(% style="width:343px" %) | ||
| 1024 | |(% style="width:186px" %)Query|(% style="width:363px" %)qry: NamePersonalisationSchemeQueryType|(% style="width:343px" %) | ||
| 1025 | |||
| 1026 | **RulesetSchemeQueryType: **RulesetSchemeQueryType defines the structure of a ruleset scheme query message. | ||
| 1027 | |||
| 1028 | Derivation: | ||
| 1029 | |||
| 1030 | * //MessageType// (restriction) | ||
| 1031 | ** RulesetSchemeQueryType | ||
| 1032 | |||
| 1033 | Content: | ||
| 1034 | |||
| 1035 | Header, Query | ||
| 1036 | |||
| 1037 | Element Documentation: | ||
| 1038 | |||
| 1039 | (% style="width:886.294px" %) | ||
| 1040 | |(% style="width:152px" %)**Name**|(% style="width:311px" %)**Type**|(% style="width:420px" %)**Documentation** | ||
| 1041 | |(% style="width:152px" %)Header|(% style="width:311px" %)BasicHeaderType|(% style="width:420px" %) | ||
| 1042 | |(% style="width:152px" %)Query|(% style="width:311px" %)qry: RulesetSchemeQueryType|(% style="width:420px" %) | ||
| 1043 | |||
| 1044 | **UserDefinedOperatorSchemeQueryType: **UserDefinedOperatorSchemeQueryType defines the structure of a user defined operator scheme query message. | ||
| 1045 | |||
| 1046 | Derivation: | ||
| 1047 | |||
| 1048 | * //MessageType// (restriction) | ||
| 1049 | ** UserDefinedOperatorSchemeQueryType | ||
| 1050 | |||
| 1051 | Content: | ||
| 1052 | |||
| 1053 | Header, Query | ||
| 1054 | |||
| 1055 | Element Documentation: | ||
| 1056 | |||
| 1057 | (% style="width:866.294px" %) | ||
| 1058 | |(% style="width:174px" %)**Name**|(% style="width:358px" %)**Type**|(% style="width:331px" %)**Documentation** | ||
| 1059 | |(% style="width:174px" %)Header|(% style="width:358px" %)BasicHeaderType|(% style="width:331px" %) | ||
| 1060 | |(% style="width:174px" %)Query|(% style="width:358px" %)qry: UserDefinedOperatorSchemeQueryType|(% style="width:331px" %) | ||
| 1061 | |||
| 1062 | **CustomTypeSchemeQueryType: **CustomTypeSchemeQueryType defines the structure of a custom type scheme query message. | ||
| 1063 | |||
| 1064 | Derivation: | ||
| 1065 | |||
| 1066 | * //MessageType// (restriction) | ||
| 1067 | ** CustomTypeSchemeQueryType | ||
| 1068 | |||
| 1069 | Content: | ||
| 1070 | |||
| 1071 | Header, Query | ||
| 1072 | |||
| 1073 | Element Documentation: | ||
| 1074 | |||
| 1075 | (% style="width:828.294px" %) | ||
| 1076 | |(% style="width:200px" %)**Name**|(% style="width:308px" %)**Type**|(% style="width:317px" %)**Documentation** | ||
| 1077 | |(% style="width:200px" %)Header|(% style="width:308px" %)BasicHeaderType|(% style="width:317px" %) | ||
| 1078 | |(% style="width:200px" %)Query|(% style="width:308px" %)qry: CustomTypeSchemeQueryType|(% style="width:317px" %) | ||
| 1079 | |||
| 1080 | **ErrorType: **ErrorType describes the structure of an error response. | ||
| 1081 | |||
| 1082 | Content: | ||
| 1083 | |||
| 1084 | ErrorMessage+ | ||
| 1085 | |||
| 1086 | Element Documentation: | ||
| 1087 | |||
| 1088 | (% style="width:899.294px" %) | ||
| 1089 | |**Name**|**Type**|(% style="width:546px" %)**Documentation** | ||
| 1090 | |ErrorMessage|com: CodedStatusMessageTy pe|(% style="width:546px" %)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. | ||
| 1091 | |||
| 1092 | **//BaseHeaderType//: **BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this | ||
| 1093 | |||
| 1094 | Content: | ||
| 1095 | |||
| 1096 | ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure*, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source* | ||
| 1097 | |||
| 1098 | Element Documentation: | ||
| 1099 | |||
| 1100 | (% style="width:891.294px" %) | ||
| 1101 | |**Name**|**Type**|(% style="width:552px" %)**Documentation** | ||
| 1102 | |ID|com:IDType|(% style="width:552px" %)ID identifies an identification for the message, assigned by the sender. | ||
| 1103 | |Test|xs:boolean|(% style="width:552px" %)Test indicates whether the message is for test purposes or not. | ||
| 1104 | |Prepared|HeaderTimeType|(% style="width:552px" %)Prepared is the date the message was prepared. | ||
| 1105 | |Sender|SenderType|(% style="width:552px" %)Sender is information about the party that is transmitting the message. | ||
| 1106 | |Receiver|PartyType|(% style="width:552px" %)Receiver is information about the party that is the intended recipient of the message. | ||
| 1107 | |com:Name|com:TextType|(% style="width:552px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. | ||
| 1108 | |Structure|//com: PayloadStructureType//|(% style="width:552px" %)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. | ||
| 1109 | |DataProvider|com: DataProviderReferenceType|(% style="width:552px" %)DataProvider identifies the provider of the data for a data/reference metadata message. | ||
| 1110 | |DataSetAction|com:ActionType|(% style="width:552px" %)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). | ||
| 1111 | |DataSetID|com:IDType|(% style="width:552px" %)DataSetID provides an identifier for a contained data set. | ||
| 1112 | |Extracted|xs:dateTime|(% style="width:552px" %)Extracted is a time-stamp from the system rendering the data. | ||
| 1113 | |ReportingBegin|com: ObservationalTimePeriodType|(% style="width:552px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data). | ||
| 1114 | |ReportingEnd|com: ObservationalTimePeriodType|(% style="width:552px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data). | ||
| 1115 | |EmbargoDate|xs:dateTime|(% style="width:552px" %)EmbargoDate holds a time period before which the data included in this message is not available. | ||
| 1116 | |Source|com:TextType|(% style="width:552px" %)Source provides human-readable information about the source of the data. | ||
| 1117 | |||
| 1118 | **StructureHeaderType: **StructureHeaderType defines the structure for structural metadata messages. | ||
| 1119 | |||
| 1120 | Derivation: | ||
| 1121 | |||
| 1122 | * //BaseHeaderType// (restriction) | ||
| 1123 | ** StructureHeaderType | ||
| 1124 | |||
| 1125 | Content: | ||
| 1126 | |||
| 1127 | ID, Test, Prepared, Sender, Receiver*, com:Name*, Source* | ||
| 1128 | |||
| 1129 | Element Documentation: | ||
| 1130 | |||
| 1131 | (% style="width:1099.29px" %) | ||
| 1132 | |**Name**|(% style="width:224px" %)**Type**|(% style="width:663px" %)**Documentation** | ||
| 1133 | |ID|(% style="width:224px" %)com:IDType|(% style="width:663px" %)ID identifies an identification for the message, assigned by the sender. | ||
| 1134 | |Test|(% style="width:224px" %)xs:boolean|(% style="width:663px" %)Test indicates whether the message is for test purposes or not. | ||
| 1135 | |Prepared|(% style="width:224px" %)HeaderTimeType|(% style="width:663px" %)Prepared is the date the message was prepared. | ||
| 1136 | |Sender|(% style="width:224px" %)SenderType|(% style="width:663px" %)Sender is information about the party that is transmitting the message. | ||
| 1137 | |Receiver|(% style="width:224px" %)PartyType|(% style="width:663px" %)Receiver is information about the party that is the intended recipient of the message. | ||
| 1138 | |com:Name|(% style="width:224px" %)com:TextType|(% style="width:663px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. | ||
| 1139 | |Source|(% style="width:224px" %)com:TextType|(% style="width:663px" %)Source provides human-readable information about the source of the data. | ||
| 1140 | |||
| 1141 | **GenericDataHeaderType: **GenericDataHeaderType defines the header structure for a generic data message. | ||
| 1142 | |||
| 1143 | Derivation: | ||
| 1144 | |||
| 1145 | * //BaseHeaderType// (restriction) | ||
| 1146 | ** GenericDataHeaderType | ||
| 1147 | |||
| 1148 | Content: | ||
| 1149 | |||
| 1150 | ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source* | ||
| 1151 | |||
| 1152 | Element Documentation: | ||
| 1153 | |||
| 1154 | (% style="width:895.294px" %) | ||
| 1155 | |**Name**|**Type**|(% style="width:556px" %)**Documentation** | ||
| 1156 | |ID|com:IDType|(% style="width:556px" %)ID identifies an identification for the message, assigned by the sender. | ||
| 1157 | |Test|xs:boolean|(% style="width:556px" %)Test indicates whether the message is for test purposes or not. | ||
| 1158 | |Prepared|HeaderTimeType|(% style="width:556px" %)Prepared is the date the message was prepared. | ||
| 1159 | |Sender|SenderType|(% style="width:556px" %)Sender is information about the party that is transmitting the message. | ||
| 1160 | |Receiver|PartyType|(% style="width:556px" %)Receiver is information about the party that is the intended recipient of the message. | ||
| 1161 | |com:Name|com:TextType|(% style="width:556px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. | ||
| 1162 | |Structure|com: GenericDataStructureType|(% style="width:556px" %)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. | ||
| 1163 | |DataProvider|com: DataProviderReferenceType|(% style="width:556px" %)DataProvider identifies the provider of the data for a data/reference metadata message. | ||
| 1164 | |DataSetAction|com:ActionType|(% style="width:556px" %)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). | ||
| 1165 | |DataSetID|com:IDType|(% style="width:556px" %)DataSetID provides an identifier for a contained data set. | ||
| 1166 | |Extracted|xs:dateTime|(% style="width:556px" %)Extracted is a time-stamp from the system rendering the data. | ||
| 1167 | |ReportingBegin|com: ObservationalTimePeriodType|(% style="width:556px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data). | ||
| 1168 | |ReportingEnd|com: ObservationalTimePeriodType|(% style="width:556px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data). | ||
| 1169 | |EmbargoDate|xs:dateTime|(% style="width:556px" %)EmbargoDate holds a time period before which the data included in this message is not available. | ||
| 1170 | |Source|com:TextType|(% style="width:556px" %)Source provides human-readable information about the source of the data. | ||
| 1171 | |||
| 1172 | **GenericTimeSeriesDataHeaderType: **GenericTimeSeriesDataHeaderType defines the header structure for a time series only generic data message. | ||
| 1173 | |||
| 1174 | Derivation: | ||
| 1175 | |||
| 1176 | * //BaseHeaderType// (restriction) | ||
| 1177 | ** GenericDataHeaderType (restriction) | ||
| 1178 | *** GenericTimeSeriesDataHeaderType | ||
| 1179 | |||
| 1180 | Content: | ||
| 1181 | |||
| 1182 | ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source* | ||
| 1183 | |||
| 1184 | Element Documentation: | ||
| 1185 | |||
| 1186 | (% style="width:926.294px" %) | ||
| 1187 | |**Name**|**Type**|(% style="width:497px" %)**Documentation** | ||
| 1188 | |ID|com:IDType|(% style="width:497px" %)ID identifies an identification for the message, assigned by the sender. | ||
| 1189 | |Test|xs:boolean|(% style="width:497px" %)Test indicates whether the message is for test purposes or not. | ||
| 1190 | |Prepared|HeaderTimeType|(% style="width:497px" %)Prepared is the date the message was prepared. | ||
| 1191 | |Sender|SenderType|(% style="width:497px" %)Sender is information about the party that is transmitting the message. | ||
| 1192 | |Receiver|PartyType|(% style="width:497px" %)Receiver is information about the party that is the intended recipient of the message. | ||
| 1193 | |com:Name|com:TextType|(% style="width:497px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. | ||
| 1194 | |Structure|com: GenericTimeSeriesDataStructureType|(% style="width:497px" %)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. | ||
| 1195 | |DataProvider|com: DataProviderReferenceType|(% style="width:497px" %)DataProvider identifies the provider of the data for a data/reference metadata message. | ||
| 1196 | |DataSetAction|com:ActionType|(% style="width:497px" %)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). | ||
| 1197 | |DataSetID|com:IDType|(% style="width:497px" %)DataSetID provides an identifier for a contained data set. | ||
| 1198 | |Extracted|xs:dateTime|(% style="width:497px" %)Extracted is a time-stamp from the system rendering the data. | ||
| 1199 | |ReportingBegin|com: ObservationalTimePeriodType|(% style="width:497px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data). | ||
| 1200 | |ReportingEnd|com: ObservationalTimePeriodType|(% style="width:497px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data). | ||
| 1201 | |EmbargoDate|xs:dateTime|(% style="width:497px" %)EmbargoDate holds a time period before which the data included in this message is not available. | ||
| 1202 | |Source|com:TextType|(% style="width:497px" %)Source provides human-readable information about the source of the data. | ||
| 1203 | |||
| 1204 | **StructureSpecificDataHeaderType: **StructureSpecificDataHeaderType defines the header structure for a structure specific data message. | ||
| 1205 | |||
| 1206 | Derivation: | ||
| 1207 | |||
| 1208 | * //BaseHeaderType// (restriction) | ||
| 1209 | ** StructureSpecificDataHeaderType | ||
| 1210 | |||
| 1211 | Content: | ||
| 1212 | |||
| 1213 | ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source* | ||
| 1214 | |||
| 1215 | Element Documentation: | ||
| 1216 | |||
| 1217 | (% style="width:930.294px" %) | ||
| 1218 | |**Name**|**Type**|(% style="width:578px" %)**Documentation** | ||
| 1219 | |ID|com:IDType|(% style="width:578px" %)ID identifies an identification for the message, assigned by the sender. | ||
| 1220 | |Test|xs:boolean|(% style="width:578px" %)Test indicates whether the message is for test purposes or not. | ||
| 1221 | |Prepared|HeaderTimeType|(% style="width:578px" %)Prepared is the date the message was prepared. | ||
| 1222 | |Sender|SenderType|(% style="width:578px" %)Sender is information about the party that is transmitting the message. | ||
| 1223 | |Receiver|PartyType|(% style="width:578px" %)Receiver is information about the party that is the intended recipient of the message. | ||
| 1224 | |com:Name|com:TextType|(% style="width:578px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. | ||
| 1225 | |Structure|com: StructureSpecificDataStructureType|(% style="width:578px" %)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. | ||
| 1226 | |DataProvider|com: DataProviderReferenceType|(% style="width:578px" %)DataProvider identifies the provider of the data for a data/reference metadata message. | ||
| 1227 | |DataSetAction|com:ActionType|(% style="width:578px" %)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). | ||
| 1228 | |DataSetID|com:IDType|(% style="width:578px" %)DataSetID provides an identifier for a contained data set. | ||
| 1229 | |Extracted|xs:dateTime|(% style="width:578px" %)Extracted is a time-stamp from the system rendering the data. | ||
| 1230 | |ReportingBegin|com: ObservationalTimePeriodType|(% style="width:578px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data). | ||
| 1231 | |ReportingEnd|com: ObservationalTimePeriodType|(% style="width:578px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data). | ||
| 1232 | |EmbargoDate|xs:dateTime|(% style="width:578px" %)EmbargoDate holds a time period before which the data included in this message is not available. | ||
| 1233 | |Source|com:TextType|(% style="width:578px" %)Source provides human-readable information about the source of the data. | ||
| 1234 | |||
| 1235 | **StructureSpecificTimeSeriesDataHeaderType: **StructureSpecificTimeSeriesDataHeaderType defines the header structure for a time series only structure specific data message. | ||
| 1236 | |||
| 1237 | Derivation: | ||
| 1238 | |||
| 1239 | * //BaseHeaderType// (restriction) | ||
| 1240 | ** StructureSpecificDataHeaderType (restriction) | ||
| 1241 | *** StructureSpecificTimeSeriesDataHeaderType | ||
| 1242 | |||
| 1243 | Content: | ||
| 1244 | |||
| 1245 | ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source* | ||
| 1246 | |||
| 1247 | Element Documentation: | ||
| 1248 | |||
| 1249 | (% style="width:943.294px" %) | ||
| 1250 | |**Name**|(% style="width:352px" %)**Type**|(% style="width:461px" %)**Documentation** | ||
| 1251 | |ID|(% style="width:352px" %)com:IDType|(% style="width:461px" %)ID identifies an identification for the message, assigned by the sender. | ||
| 1252 | |Test|(% style="width:352px" %)xs:boolean|(% style="width:461px" %)Test indicates whether the message is for test purposes or not. | ||
| 1253 | |Prepared|(% style="width:352px" %)HeaderTimeType|(% style="width:461px" %)Prepared is the date the message was prepared. | ||
| 1254 | |Sender|(% style="width:352px" %)SenderType|(% style="width:461px" %)Sender is information about the party that is transmitting the message. | ||
| 1255 | |Receiver|(% style="width:352px" %)PartyType|(% style="width:461px" %)Receiver is information about the party that is the intended recipient of the message. | ||
| 1256 | |com:Name|(% style="width:352px" %)com:TextType|(% style="width:461px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. | ||
| 1257 | |Structure|(% style="width:352px" %)com: StructureSpecificDataTimeSeriesStructureType|(% style="width:461px" %)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. | ||
| 1258 | |DataProvider|(% style="width:352px" %)com: DataProviderReferenceType|(% style="width:461px" %)DataProvider identifies the provider of the data for a data/reference metadata message. | ||
| 1259 | |DataSetAction|(% style="width:352px" %)com:ActionType|(% style="width:461px" %)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). | ||
| 1260 | |DataSetID|(% style="width:352px" %)com:IDType|(% style="width:461px" %)DataSetID provides an identifier for a contained data set. | ||
| 1261 | |Extracted|(% style="width:352px" %)xs:dateTime|(% style="width:461px" %)Extracted is a time-stamp from the system rendering the data. | ||
| 1262 | |ReportingBegin|(% style="width:352px" %)com: ObservationalTimePeriodType|(% style="width:461px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data). | ||
| 1263 | |ReportingEnd|(% style="width:352px" %)com: ObservationalTimePeriodType|(% style="width:461px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data). | ||
| 1264 | |EmbargoDate|(% style="width:352px" %)xs:dateTime|(% style="width:461px" %)EmbargoDate holds a time period before which the data included in this message is not available. | ||
| 1265 | |Source|(% style="width:352px" %)com:TextType|(% style="width:461px" %)Source provides human-readable information about the source of the data. | ||
| 1266 | |||
| 1267 | **GenericMetadataHeaderType: **GenericMetadataHeaderType defines the header format for generic reference metadata. | ||
| 1268 | |||
| 1269 | Derivation: | ||
| 1270 | |||
| 1271 | * //BaseHeaderType// (restriction) | ||
| 1272 | ** GenericMetadataHeaderType | ||
| 1273 | |||
| 1274 | Content: | ||
| 1275 | |||
| 1276 | ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, Source* | ||
| 1277 | |||
| 1278 | Element Documentation: | ||
| 1279 | |||
| 1280 | (% style="width:928.294px" %) | ||
| 1281 | |**Name**|**Type**|(% style="width:554px" %)**Documentation** | ||
| 1282 | |ID|com:IDType|(% style="width:554px" %)ID identifies an identification for the message, assigned by the sender. | ||
| 1283 | |Test|xs:boolean|(% style="width:554px" %)Test indicates whether the message is for test purposes or not. | ||
| 1284 | |Prepared|HeaderTimeType|(% style="width:554px" %)Prepared is the date the message was prepared. | ||
| 1285 | |Sender|SenderType|(% style="width:554px" %)Sender is information about the party that is transmitting the message. | ||
| 1286 | |Receiver|PartyType|(% style="width:554px" %)Receiver is information about the party that is the intended recipient of the message. | ||
| 1287 | |com:Name|com:TextType|(% style="width:554px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. | ||
| 1288 | |Structure|com: GenericMetadataStructureType|(% style="width:554px" %)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. | ||
| 1289 | |DataProvider|com: DataProviderReferenceType|(% style="width:554px" %)DataProvider identifies the provider of the data for a data/reference metadata message. | ||
| 1290 | |DataSetAction|com:ActionType|(% style="width:554px" %)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). | ||
| 1291 | |DataSetID|com:IDType|(% style="width:554px" %)DataSetID provides an identifier for a contained data set. | ||
| 1292 | |Extracted|xs:dateTime|(% style="width:554px" %)Extracted is a time-stamp from the system rendering the data. | ||
| 1293 | |Source|com:TextType|(% style="width:554px" %)Source provides human-readable information about the source of the data. | ||
| 1294 | |||
| 1295 | **StructureSpecificMetadataHeaderType: **StructureSpecificMetadataHeaderType defines the header format for metadata structure definition specific reference metadata messages. | ||
| 1296 | |||
| 1297 | Derivation: | ||
| 1298 | |||
| 1299 | * //BaseHeaderType// (restriction) | ||
| 1300 | ** StructureSpecificMetadataHeaderType | ||
| 1301 | |||
| 1302 | Content: | ||
| 1303 | |||
| 1304 | ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, Source* | ||
| 1305 | |||
| 1306 | Element Documentation: | ||
| 1307 | |||
| 1308 | (% style="width:996.294px" %) | ||
| 1309 | |**Name**|**Type**|(% style="width:557px" %)**Documentation** | ||
| 1310 | |ID|com:IDType|(% style="width:557px" %)ID identifies an identification for the message, assigned by the sender. | ||
| 1311 | |Test|xs:boolean|(% style="width:557px" %)Test indicates whether the message is for test purposes or not. | ||
| 1312 | |Prepared|HeaderTimeType|(% style="width:557px" %)Prepared is the date the message was prepared. | ||
| 1313 | |Sender|SenderType|(% style="width:557px" %)Sender is information about the party that is transmitting the message. | ||
| 1314 | |Receiver|PartyType|(% style="width:557px" %)Receiver is information about the party that is the intended recipient of the message. | ||
| 1315 | |com:Name|com:TextType|(% style="width:557px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values. | ||
| 1316 | |Structure|com: StructureSpecificMetadataStructureType|(% style="width:557px" %)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. | ||
| 1317 | |DataProvider|com: DataProviderReferenceType|(% style="width:557px" %)DataProvider identifies the provider of the data for a data/reference metadata message. | ||
| 1318 | |DataSetAction|com:ActionType|(% style="width:557px" %)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). | ||
| 1319 | |DataSetID|com:IDType|(% style="width:557px" %)DataSetID provides an identifier for a contained data set. | ||
| 1320 | |Extracted|xs:dateTime|(% style="width:557px" %)Extracted is a time-stamp from the system rendering the data. | ||
| 1321 | |Source|com:TextType|(% style="width:557px" %)Source provides human-readable information about the source of the data. | ||
| 1322 | |||
| 1323 | **BasicHeaderType: **BasicHeaderType defines the most basic header information used in simple message exchanges. | ||
| 1324 | |||
| 1325 | Derivation: | ||
| 1326 | |||
| 1327 | * //BaseHeaderType// (restriction) | ||
| 1328 | ** BasicHeaderType | ||
| 1329 | |||
| 1330 | Content: | ||
| 1331 | |||
| 1332 | ID, Test, Prepared, Sender, Receiver | ||
| 1333 | |||
| 1334 | Element Documentation: | ||
| 1335 | |||
| 1336 | (% style="width:903.294px" %) | ||
| 1337 | |**Name**|(% style="width:236px" %)**Type**|(% style="width:457px" %)**Documentation** | ||
| 1338 | |ID|(% style="width:236px" %)com:IDType|(% style="width:457px" %)ID identifies an identification for the message, assigned by the sender. | ||
| 1339 | |Test|(% style="width:236px" %)xs:boolean|(% style="width:457px" %)Test indicates whether the message is for test purposes or not. | ||
| 1340 | |Prepared|(% style="width:236px" %)HeaderTimeType|(% style="width:457px" %)Prepared is the date the message was prepared. | ||
| 1341 | |Sender|(% style="width:236px" %)SenderType|(% style="width:457px" %)Sender is information about the party that is transmitting the message. | ||
| 1342 | |Receiver|(% style="width:236px" %)PartyType|(% style="width:457px" %)Receiver is information about the party that is the intended recipient of the message. | ||
| 1343 | |||
| 1344 | **PartyType: **PartyType defines the information which is sent about various parties such as senders and receivers of messages. | ||
| 1345 | |||
| 1346 | Attributes: | ||
| 1347 | |||
| 1348 | id | ||
| 1349 | |||
| 1350 | Content: | ||
| 1351 | |||
| 1352 | com:Name*, Contact* | ||
| 1353 | |||
| 1354 | Attribute Documentation: | ||
| 1355 | |||
| 1356 | (% style="width:739.294px" %) | ||
| 1357 | |(% style="width:125px" %)**Name**|(% style="width:190px" %)**Type**|(% style="width:421px" %)**Documentation** | ||
| 1358 | |(% style="width:125px" %)id|(% style="width:190px" %)com:IDType|(% style="width:421px" %)The id attribute holds the identification of the party. | ||
| 1359 | |||
| 1360 | Element Documentation: | ||
| 1361 | |||
| 1362 | (% style="width:751.294px" %) | ||
| 1363 | |(% style="width:134px" %)**Name**|(% style="width:183px" %)**Type**|(% style="width:431px" %)**Documentation** | ||
| 1364 | |(% style="width:134px" %)com:Name|(% style="width:183px" %)com:TextType|(% style="width:431px" %)Name is a human-readable name of the party. | ||
| 1365 | |(% style="width:134px" %)Contact|(% style="width:183px" %)ContactType|(% style="width:431px" %)Contact provides contact information for the party in regard to the transmission of the message. | ||
| 1366 | |||
| 1367 | **SenderType: **SenderType extends the basic party structure to add an optional time zone declaration. | ||
| 1368 | |||
| 1369 | Derivation: | ||
| 1370 | |||
| 1371 | * PartyType (extension) | ||
| 1372 | ** SenderType | ||
| 1373 | |||
| 1374 | Attributes: | ||
| 1375 | |||
| 1376 | id | ||
| 1377 | |||
| 1378 | Content: | ||
| 1379 | |||
| 1380 | com:Name*, Contact*, Timezone? | ||
| 1381 | |||
| 1382 | Attribute Documentation: | ||
| 1383 | |||
| 1384 | (% style="width:824.294px" %) | ||
| 1385 | |(% style="width:177px" %)**Name**|(% style="width:241px" %)**Type**|(% style="width:403px" %)**Documentation** | ||
| 1386 | |(% style="width:177px" %)id|(% style="width:241px" %)com:IDType|(% style="width:403px" %)The id attribute holds the identification of the party. | ||
| 1387 | |||
| 1388 | Element Documentation: | ||
| 1389 | |||
| 1390 | |**Name**|**Type**|**Documentation** | ||
| 1391 | |com:Name|com:TextType|Name is a human-readable name of the party. | ||
| 1392 | |Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message. | ||
| 1393 | |Timezone|com: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". | ||
| 1394 | |||
| 1395 | **ContactType: **ContactType provides defines the contact information about a party. | ||
| 1396 | |||
| 1397 | Content: | ||
| 1398 | |||
| 1399 | com:Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)* | ||
| 1400 | |||
| 1401 | Element Documentation: | ||
| 1402 | |||
| 1403 | |**Name**|**Type**|**Documentation** | ||
| 1404 | |com:Name|com:TextType|Name contains a human-readable name for the contact. | ||
| 1405 | |Department|com:TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works. | ||
| 1406 | |Role|com:TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact. | ||
| 1407 | |Telephone|xs:string|Telephone holds the telephone number for the contact person. | ||
| 1408 | |Fax|xs:string|Fax holds the fax number for the contact person. | ||
| 1409 | |X400|xs:string|X400 holds the X.400 address for the contact person. | ||
| 1410 | |URI|xs:anyURI|URI holds an information URL for the contact person. | ||
| 1411 | |Email|xs:string|Email holds the email address for the contact person. | ||
| 1412 | |||
| 1413 | === 2.1.4 Simple Types === | ||
| 1414 | |||
| 1415 | **HeaderTimeType: **Provides a union type of xs:date and xs:dateTime for the header fields in the message. | ||
| 1416 | |||
| 1417 | Union of: | ||
| 1418 | |||
| 1419 | xs:dateTime, xs:date. | ||
| 1420 | |||
| 1421 | == 2.2 Message Footer Namespace == | ||
| 1422 | |||
| 1423 | **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message/footer** | ||
| 1424 | |||
| 1425 | === 2.2.1 Summary === | ||
| 1426 | |||
| 1427 | Referenced Namespaces: | ||
| 1428 | |||
| 1429 | |**Namespace**|**Prefix** | ||
| 1430 | |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com | ||
| 1431 | |http:~/~/www.w3.org/2001/XMLSchema|xs | ||
| 1432 | |||
| 1433 | Contents: | ||
| 1434 | |||
| 1435 | 1 Global Element | ||
| 1436 | 2 Complex Types | ||
| 1437 | 1 Simple Type | ||
| 1438 | |||
| 1439 | 1. | ||
| 1440 | 11. | ||
| 1441 | 111. Global Elements | ||
| 1442 | |||
| 1443 | **Footer (FooterType): **Footer is used to communicate information such as error and warnings after the payload of a message. | ||
| 1444 | |||
| 1445 | 1. | ||
| 1446 | 11. | ||
| 1447 | 111. Complex Types | ||
| 1448 | |||
| 1449 | **FooterType: **FooterType describes the structure of a message footer. The footer is used to convey any error, information, or warning messages. This is to be used when the message has payload, but also needs to communicate additional information. If an error occurs and no payload is generated, an Error message should be returned. | ||
| 1450 | |||
| 1451 | Content: | ||
| 1452 | |||
| 1453 | Message+ | ||
| 1454 | |||
| 1455 | Element Documentation: | ||
| 1456 | |||
| 1457 | |**Name**|**Type**|**Documentation** | ||
| 1458 | |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. | ||
| 1459 | |||
| 1460 | **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. | ||
| 1461 | |||
| 1462 | Derivation: | ||
| 1463 | |||
| 1464 | com:StatusMessageType (restriction) | ||
| 1465 | [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] com:CodedStatusMessageType (extension) | ||
| 1466 | [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] FooterMessageType | ||
| 1467 | |||
| 1468 | Attributes: | ||
| 1469 | |||
| 1470 | code, severity? | ||
| 1471 | |||
| 1472 | Content: | ||
| 1473 | |||
| 1474 | com:Text+ | ||
| 1475 | |||
| 1476 | Attribute Documentation: | ||
| 1477 | |||
| 1478 | |**Name**|**Type**|**Documentation** | ||
| 1479 | |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. | ||
| 1480 | |severity|SeverityCodeType| | ||
| 1481 | |||
| 1482 | Element Documentation: | ||
| 1483 | |||
| 1484 | |**Name**|**Type**|**Documentation** | ||
| 1485 | |com:Text|com:TextType|Text contains the text of the message, in parallel language values. | ||
| 1486 | |||
| 1487 | 1. | ||
| 1488 | 11. | ||
| 1489 | 111. Simple Types | ||
| 1490 | |||
| 1491 | **SeverityCodeType:** | ||
| 1492 | |||
| 1493 | Derived by restriction of xs:string . | ||
| 1494 | |||
| 1495 | Enumerations: | ||
| 1496 | |||
| 1497 | |**Value**|**Documentation** | ||
| 1498 | |Error|Error indicates the status message coresponds to an error. | ||
| 1499 | |Warning|Warning indicates that the status message corresponds to a warning. | ||
| 1500 | |Information|Information indicates that the status message corresponds to an informational message. | ||
| 1501 | |||
| 1502 | |||
| 1503 | |||
| 1504 | |||
| 1505 | |||
| 1506 | |||
| 1507 | |||
| 1508 | |||
| 1509 | |||
| 1510 | |||
| 1511 | |||
| 1512 | |||
| 1513 | |||
| 1514 | |||
| 1515 |