Changes for page Part V. Registry Namespace
Last modified by Elena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -64,9 +64,10 @@ 64 64 65 65 Element Documentation: 66 66 67 -|**Name**|**Type**|**Documentation**| 68 -|SimpleDataSource|xs:anyURI|SimpleDatasource describes a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that is an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data or metadata message. It requires only the URL of the data.| 69 -|QueryableDataSource|QueryableDataSourceT ype|QueryableDatasource describes a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that can be queried using the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] REST interfaces.| 67 +(% style="width:1038.29px" %) 68 +|**Name**|(% style="width:221px" %)**Type**|(% style="width:536px" %)**Documentation** 69 +|SimpleDataSource|(% style="width:221px" %)xs:anyURI|(% style="width:536px" %)SimpleDatasource describes a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that is an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data or metadata message. It requires only the URL of the data. 70 +|QueryableDataSource|(% style="width:221px" %)QueryableDataSourceType|(% style="width:536px" %)QueryableDatasource describes a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that can be queried using the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] REST interfaces. 70 70 71 71 **SimpleDataSourceType:** SimpleDataSourceType describes a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. The URL of the data is contained in the content. 72 72 ... ... @@ -80,12 +80,13 @@ 80 80 TYPE? 81 81 82 82 Content: 83 -Attribute Documentation: 84 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 84 84 85 -|**Name**|**Type**|**Documentation**| 86 -|TYPE (fixed: SIMPLE)|xs:string|TYPE is a fixed attribute that is used to ensure only one simple data source may be provided, when it is referenced in a uniqueness constraint.| 86 +(% style="width:1046.29px" %) 87 +|**Name**|**Type**|**Documentation** 88 +|TYPE (fixed: SIMPLE)|xs:string|TYPE is a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that is used to ensure only one simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]] may be provided, when it is referenced in a uniqueness (% style="color:#e74c3c" %)constraint(%%). 87 87 88 -**QueryableDataSourceType:** QueryableDataSourceType describes a queryable data source, and add a fixed attribute for ensuring only one queryable source can be provided. 90 +**QueryableDataSourceType:** QueryableDataSourceType describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]], and add a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for ensuring only one queryable source can be provided. 89 89 90 90 Derivation: 91 91 ... ... @@ -98,19 +98,20 @@ 98 98 Content: 99 99 DataURL, WSDLURL?, WADLURL? 100 100 101 -Attribute Documentation: 103 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 102 102 103 -|**Name**|**Type**|**Documentation**| 104 -|isRESTDatasource|xs:boolean|The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.| 105 -|isWebServiceDatasource|xs:boolean|The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.| 106 -|TYPE (fixed: QUERY)|xs:string|TYPE is a fixed attribute that is used to ensure only one queryable data source may be provided, when it is referenced in a uniqueness constraint.| 105 +(% style="width:1084.29px" %) 106 +|**Name**|**Type**|**Documentation** 107 +|isRESTDatasource|xs:boolean|The isRESTDatasource [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates, if true, that the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is accessible via the REST protocol. 108 +|isWebServiceDatasource|xs:boolean|The isWebServiceDatasource [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates, if true, that the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is accessible via Web Services protocols. 109 +|TYPE (fixed: QUERY)|xs:string|TYPE is a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that is used to ensure only one queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] may be provided, when it is referenced in a uniqueness (% style="color:#e74c3c" %)constraint(%%). 107 107 108 108 Element Documentation: 109 109 110 110 |**Name**|**Type**|**Documentation**| 111 -|DataURL|xs:anyURI|DataURL contains the URL of the data source.| 112 -|WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.| 113 -|WADLURL|xs:anyURI|WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source.| 114 +|DataURL|xs:anyURI|DataURL contains the URL of the [[data source>>doc:sdmx:Glossary.Data source.WebHome]].| 115 +|WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]].| 116 +|WADLURL|xs:anyURI|WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]].| 114 114 115 115 **IdentifiableQueryType:** IdentifiableQueryType describes the structure of a query for an identifiable object. 116 116 ... ... @@ -120,10 +120,11 @@ 120 120 Content: 121 121 {Empty} 122 122 123 -Attribute Documentation: 126 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 124 124 125 -|**Name**|**Type**|**Documentation**| 126 -|id (default: %)|IDQueryType|The id attribute is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.| 128 +(% style="width:1040.29px" %) 129 +|**Name**|**Type**|**Documentation** 130 +|id (default:%)|IDQueryType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value. 127 127 128 128 **VersionableQueryType:** VersionableQueryType describes the structure of a query for a versionable object. 129 129 ... ... @@ -140,9 +140,10 @@ 140 140 141 141 Attribute Documentation: 142 142 143 -|**Name**|**Type**|**Documentation**| 144 -|id (default: %)|IDQueryType|The id attribute is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.| 145 -|version (default: \*)|VersionQueryType|The version attribute is used to query for an object based on its version. This can be and explicit value, wild-carded ("%"), or late-bound ("\*"). A wild carded version will match any version of the object where as a late-bound version will only match the latest version.| 147 +(% style="width:1070.29px" %) 148 +|**Name**|**Type**|(% style="width:775px" %)**Documentation** 149 +|id (default: %)|IDQueryType|(% style="width:775px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value. 150 +|version (default:\*)|VersionQueryType|(% style="width:775px" %)The (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its (% style="color:#e74c3c" %)version(%%). This can be and explicit value, wild-carded ("%"), or late-bound ("\*"). A wild carded (% style="color:#e74c3c" %)version(%%) will match any (% style="color:#e74c3c" %)version(%%) of the object where as a late-bound (% style="color:#e74c3c" %)version(%%) will only match the latest (% style="color:#e74c3c" %)version(%%). 146 146 147 147 **MaintainableQueryType:** MaintainableQueryType describes the structure of a query for a maintainable object. 148 148 ... ... @@ -160,10 +160,11 @@ 160 160 161 161 Attribute Documentation: 162 162 163 -|**Name**|**Type**|**Documentation**| 164 -|id (default: %)|IDQueryType|The id attribute is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.| 165 -|version (default: \*)|VersionQueryType|The version attribute is used to query for an object based on its version. This can be and explicit value, wild-carded ("%"), or late-bound ("\*"). A wild carded version will match any version of the object where as a late-bound version will only match the latest version.| 166 -|agencyID (default: %)|NestedIDQueryType|The agencyID attribute is used to query for an object based on its maintenance agency's identifier. This is either an explicit value, or completely wild cared with the "%" value.| 168 +(% style="width:1118.29px" %) 169 +|(% style="width:201px" %)**Name**|(% style="width:127px" %)**Type**|(% style="width:789px" %)**Documentation** 170 +|(% style="width:201px" %)id (default: %)|(% style="width:127px" %)IDQueryType|(% style="width:789px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value. 171 +|(% style="width:201px" %)version (default: \*)|(% style="width:127px" %)VersionQueryType|(% style="width:789px" %)The (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its (% style="color:#e74c3c" %)version(%%). This can be and explicit value, wild-carded ("%"), or late-bound ("\*"). A wild carded (% style="color:#e74c3c" %)version(%%) will match any (% style="color:#e74c3c" %)version(%%) of the object where as a late-bound (% style="color:#e74c3c" %)version(%%) will only match the latest (% style="color:#e74c3c" %)version(%%). 172 +|(% style="width:201px" %)agencyID (default: %)|(% style="width:127px" %)NestedIDQueryType|(% style="width:789px" %)The agencyID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]]'s identifier. This is either an explicit value, or completely wild cared with the "%" value. 167 167 168 168 **StatusMessageType:** StatusMessageType carries the text of error messages and/or warnings in response to queries or requests. 169 169 ... ... @@ -175,15 +175,17 @@ 175 175 176 176 Attribute Documentation: 177 177 178 -|**Name**|**Type**|**Documentation**| 179 -|status|StatusType|The status attribute carries the status of the query or request.| 184 +(% style="width:1011.29px" %) 185 +|**Name**|**Type**|**Documentation** 186 +|status|StatusType|The status [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] carries the status of the query or request. 180 180 181 181 Element Documentation: 182 182 183 -|**Name**|**Type**|**Documentation**| 184 -|MessageText|StatusMessageType|MessageText contains the text of the error and/or warning message. It can occur multiple times to communicate message for multiple warnings or errors.| 190 +(% style="width:1011.29px" %) 191 +|**Name**|**Type**|**Documentation** 192 +|MessageText|StatusMessageType|MessageText contains the text of the error and/or warning message. It can occur multiple times to communicate message for multiple warnings or errors. 185 185 186 -**SubmitRegistrationsRequestType:** SubmitRegistrationsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of data/metadata set registrations. 194 +**SubmitRegistrationsRequestType:** SubmitRegistrationsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of data/[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] registrations. 187 187 188 188 Content: 189 189 RegistrationRequest+ ... ... @@ -190,8 +190,9 @@ 190 190 191 191 Element Documentation: 192 192 193 -|**Name**|**Type**|**Documentation**| 194 -|RegistrationRequest|RegistrationRequestT ype|RegistrationRequest provides the details of a requested registration and the action to take on it. A reference to a provision agreement that exists in the registry must be provide along with a simple and/or queryable data source. The id should only be provided when updating or deleting a registration.| 201 +(% style="width:1012.29px" %) 202 +|**Name**|**Type**|**Documentation** 203 +|RegistrationRequest|RegistrationRequestType|RegistrationRequest provides the details of a requested registration and the action to take on it. A reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] that exists in the registry must be provide along with a simple and/or queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. The id should only be provided when updating or deleting a registration. 195 195 196 196 **RegistrationRequestType:** RegistrationRequestType describes the structure of a single registration request. It contains the details of a registation and an action field to indicate the action to be taken on the contained registration. 197 197 ... ... @@ -203,14 +203,15 @@ 203 203 204 204 Attribute Documentation: 205 205 206 -|**Name**|**Type**|**Documentation**| 207 -|action|ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a registration.| 215 +(% style="width:1008.29px" %) 216 +|**Name**|**Type**|**Documentation** 217 +|action|ActionType|The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this is an addition, a modification, or a deletion of a registration. 208 208 209 209 Element Documentation: 210 210 211 - |**Name**|**Type**|**Documentation**|212 - 213 -|Registration|RegistrationType|Registration contains the details of the data/metadata set registration to be added, updated, or deleted. |221 +(% style="width:1013.29px" %) 222 +|**Name**|**Type**|**Documentation** 223 +|Registration|RegistrationType|Registration contains the details of the data/[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] registration to be added, updated, or deleted. 214 214 215 215 **SubmitRegistrationsResponseType:** SubmitRegistrationsResponseType describes the structure of a registration response. For each submitted registration in the request, a registration status is provided. The status elements should be provided in the same order as the submitted registrations, although each status will echo the request to ensure accurate processing of the responses. 216 216 ... ... @@ -219,8 +219,9 @@ 219 219 220 220 Element Documentation: 221 221 222 -|**Name**|**Type**|**Documentation**| 223 -|RegistrationStatus|RegistrationStatusTy pe|RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.| 232 +(% style="width:1023.29px" %) 233 +|**Name**|**Type**|**Documentation** 234 +|RegistrationStatus|RegistrationStatusTy pe|RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request. 224 224 225 225 **RegistrationStatusType:** RegistrationStatusType describes the structure of a registration status. 226 226 ... ... @@ -229,11 +229,12 @@ 229 229 230 230 Element Documentation: 231 231 232 -|**Name**|**Type**|**Documentation**| 233 -|Registration|RegistrationType|Registration, at the very least echoes the submitted registration. It the request was to create a new registration and it was successful, an id must be supplied.| 234 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration request, and if necessary, any error or warning information.| 243 +(% style="width:1005.29px" %) 244 +|**Name**|**Type**|(% style="width:578px" %)**Documentation** 245 +|Registration|RegistrationType|(% style="width:578px" %)Registration, at the very least echoes the submitted registration. It the request was to create a new registration and it was successful, an id must be supplied. 246 +|StatusMessage|StatusMessageType|(% style="width:578px" %)StatusMessage provides that status for the registration request, and if necessary, any error or warning information. 235 235 236 -**QueryRegistrationRequestType:** QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, reference metadata, or both) must be specified. It is possible to query for registrations for a particular provision agreement, data provider, or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing constraints in the form of explicit time periods, constraint regions, and key sets. When constraint regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions. 248 +**QueryRegistrationRequestType:** QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]], or both) must be specified. It is possible to query for registrations for a particular [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]], or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing (% style="color:#e74c3c" %)constraints(%%) in the form of explicit [[time periods>>doc:sdmx:Glossary.Time period.WebHome]], (% style="color:#e74c3c" %)constraint(%%) regions, and key sets. When (% style="color:#e74c3c" %)constraint(%%) regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions. 237 237 238 238 Attributes: 239 239 returnConstraints? ... ... @@ -243,22 +243,24 @@ 243 243 244 244 Attribute Documentation: 245 245 246 -|**Name**|**Type**|**Documentation**| 247 -|returnConstraints (default: false)|xs:boolean|The returnConstraints attribute determines whether information about the constraints on the data or metadata sets returned should also be sent the results.| 258 +(% style="width:1004.29px" %) 259 +|**Name**|**Type**|**Documentation** 260 +|returnConstraints (default: false)|xs:boolean|The returnConstraints [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] determines whether information about the (% style="color:#e74c3c" %)constraints(%%) on the data or [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] returned should also be sent the results. 248 248 249 249 Element Documentation: 250 250 251 -|**Name**|**Type**|**Documentation**| 252 -|QueryType|QueryTypeType|QueryType defines the type of sets (data, metadata, or both) that are being queried for.| 253 -|All|EmptyType|All indicates that all registrations meeting the other criteria of the query should be returned.| 254 -|ProvisionAgreement|ProvisionAgreementRe ferenceType|ProvisionAgreement provides a reference to a provision agreement in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.| 255 -|DataProvider|DataProviderReferenc eType|DataProvider provides a reference to a data provider in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.| 256 -|Dataflow|DataflowReferenceTyp e|Dataflow provides a reference to a data flow in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.| 257 -|Metadataflow|MetadataflowReferenc eType|Metadataflow provides a reference to a metadata flow in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields| 258 -|ReferencePeriod|ReferencePeriodType|ReferencePeriod provides an inclusive start and end date for the data or metadata being sought.| 259 -|DataKeySet|DataKeySetType|DataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.| 260 -|CubeRegion|CubeRegionType|CubeRegion is used to provide sets of include or excluded values for dimensions when querying for data.| 261 -|MetadataTargetRegion|MetadataTargetRegion Type|MetadataTargetRegion is used to provide sets of included or excluded values for identifier components when querying for metadata.| 264 +(% style="width:1056.29px" %) 265 +|**Name**|**Type**|**Documentation** 266 +|QueryType|QueryTypeType|QueryType defines the type of sets (data, metadata, or both) that are being queried for. 267 +|All|EmptyType|All indicates that all registrations meeting the other criteria of the query should be returned. 268 +|ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreement provides a reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields. 269 +|DataProvider|DataProviderReferenceType|DataProvider provides a reference to a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields. 270 +|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|DataflowReferenceType|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] provides a reference to a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields. 271 +|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|MetadataflowReferenceType|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] provides a reference to a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields 272 +|ReferencePeriod|ReferencePeriodType|ReferencePeriod provides an inclusive start and end date for the data or metadata being sought. 273 +|DataKeySet|DataKeySetType|DataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought. 274 +|CubeRegion|CubeRegionType|CubeRegion is used to provide sets of include or excluded values for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] when querying for data. 275 +|MetadataTargetRegion|MetadataTargetRegionType|MetadataTargetRegion is used to provide sets of included or excluded values for identifier [[components>>doc:sdmx:Glossary.Component.WebHome]] when querying for metadata. 262 262 263 263 **QueryRegistrationResponseType:** QueryRegistrationResponseType describes the structure of a registration query response. It provides a status for the request, and if successful, the resulting data and/or metadata results. 264 264 ... ... @@ -267,11 +267,12 @@ 267 267 268 268 Element Documentation: 269 269 270 -|**Name**|**Type**|**Documentation**| 271 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.| 272 -|QueryResult|QueryResultType|QueryResult contains a result for a successful registration query. It can occur multiple times, for each registration the meets the conditions specified in the query.| 284 +(% style="width:1034.29px" %) 285 +|**Name**|**Type**|**Documentation** 286 +|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration query request, and if necessary, any error or warning information. 287 +|QueryResult|QueryResultType|QueryResult contains a result for a successful registration query. It can occur multiple times, for each registration the meets the conditions specified in the query. 273 273 274 -**QueryResultType:** QueryResultType describes the structure of a query result for a single data source. Either a data result or metadata result is detailed, depending on the data source. 289 +**QueryResultType:** QueryResultType describes the structure of a query result for a single [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. Either a data result or metadata result is detailed, depending on the [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. 275 275 276 276 Attributes: 277 277 timeSeriesMatch ... ... @@ -281,27 +281,32 @@ 281 281 282 282 Attribute Documentation: 283 283 284 -|**Name**|**Type**|**Documentation**| 285 -|timeSeriesMatch|xs:boolean|The timeSeriesMatch attribute is true when the result is an exact match with the key found in the registry - that is, when the registered data source provides a matching key. It is set to false when the data source is registered with cube-region constraints, or in any other circumstance when it cannot be established that the sought-for keys have been exactly matched. This is always true when the resulting data source is the source of a metadata set.| 299 +(% style="width:1027.29px" %) 300 +|**Name**|**Type**|(% style="width:793px" %)**Documentation** 301 +|timeSeriesMatch|xs:boolean|(% style="width:793px" %)The timeSeriesMatch [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is true when the result is an exact match with the key found in the registry - that is, when the registered [[data source>>doc:sdmx:Glossary.Data source.WebHome]] provides a matching key. It is set to false when the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is registered with cube-region (% style="color:#e74c3c" %)constraints(%%), or in any other circumstance when it cannot be established that the sought-for keys have been exactly matched. This is always true when the resulting [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is the source of a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. 286 286 287 287 Element Documentation: 288 288 289 -|**Name**|**Type**|**Documentation**| 290 -|DataResult|ResultType| | 291 -|MetadataResult|ResultType| | 305 +(% style="width:709.294px" %) 306 +|(% style="width:159px" %)**Name**|(% style="width:211px" %)**Type**|(% style="width:336px" %)**Documentation** 307 +|(% style="width:159px" %)DataResult|(% style="width:211px" %)ResultType|(% style="width:336px" %) 308 +|(% style="width:159px" %)MetadataResult|(% style="width:211px" %)ResultType|(% style="width:336px" %) 292 292 293 -**ResultType:** ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content constraints for the data source may be provided, if the query requested this information.310 +**ResultType:** 294 294 312 +ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content (% style="color:#e74c3c" %)constraints(%%) for the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] may be provided, if the query requested this information. 313 + 295 295 Content: 296 -Registration, Constraint 315 +Registration, (% style="color:#e74c3c" %)Constraint 297 297 298 298 Element Documentation: 299 299 300 -|**Name**|**Type**|**Documentation**| 301 -|Registration|RegistrationType|Registration provides the details of a matching registration. In addition to the data source and provision agreement information, the id of the registration must also be provided.| 302 -|Constraint|ConstraintReferenceT ype|Constraint provides a reference to a data or metadata constraint in the registry for the resulting data source (or possibly constraints base on the registration provision agreement, data provider, structure usage, or structure). The reference is provided for by a URN and/or a complete set of reference fields.| 319 +(% style="width:1035.29px" %) 320 +|**Name**|**Type**|(% style="width:731px" %)**Documentation** 321 +|Registration|RegistrationType|(% style="width:731px" %)Registration provides the details of a matching registration. In addition to the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] and [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] information, the id of the registration must also be provided. 322 +|(%%)(% style="color:#e74c3c" %)Constraint|ConstraintReferenceType|(% style="width:731px" %)(% style="color:#e74c3c" %)Constraint(%%) provides a reference to a data or metadata (% style="color:#e74c3c" %)constraint(%%) in the registry for the resulting [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (or possibly (% style="color:#e74c3c" %)constraints(%%) base on the registration [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]], structure usage, or structure). The reference is provided for by a URN and/or a complete set of reference fields. 303 303 304 -**SubmitStructureRequestType:** SubmitStructureRequestType describes the structure of a structure submission. Structural components are provided either in-line or referenced via a SDMX-ML Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained components, but can be overridden on a per component basis. 324 +**SubmitStructureRequestType:** SubmitStructureRequestType describes the structure of a structure submission. Structural [[components>>doc:sdmx:Glossary.Component.WebHome]] are provided either in-line or referenced via a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained [[components>>doc:sdmx:Glossary.Component.WebHome]], but can be overridden on a per [[component>>doc:sdmx:Glossary.Component.WebHome]] basis. 305 305 306 306 Attributes: 307 307 action?, externalDependencies? ... ... @@ -309,21 +309,22 @@ 309 309 Content: 310 310 (StructureLocation|Structures), SubmittedStructure 311 311 312 -Attribute Documentation: 332 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 313 313 314 -|**Name**|**Type**|**Documentation**| 315 -|action (default: Append)|ActionType|The action attribute indicates the default action (append-add, replace-update, delete, or no action-informational) to be taken on all structural components in either the external SDMX-ML Structure message or the in-line components. The default action is Append. The Replace action is not applicable to final structures in the repository, and will produce an error condition, as these can be versioned but not modified. To submit a later version of a structural object, the object should include the incremented version number.| 316 -|externalDependencies (default: false)|xs:boolean|The externalDependencies attribute indicates the default resolution of external dependencies. This should be set to true if the repository is expected to use external reference URLs in the structural components to retrieve any externally referenced objects that is used by a non-external object.| 334 +(% style="width:1060.29px" %) 335 +|**Name**|**Type**|(% style="width:737px" %)**Documentation** 336 +|action (default: Append)|ActionType|(% style="width:737px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the default action (append-add, replace-update, delete, or no action-informational) to be taken on all structural [[components>>doc:sdmx:Glossary.Component.WebHome]] in either the external [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message or the in-line [[components>>doc:sdmx:Glossary.Component.WebHome]]. The default action is Append. The Replace action is not applicable to final structures in the repository, and will produce an error condition, as these can be versioned but not modified. To submit a later (% style="color:#e74c3c" %)version(%%) of a structural object, the object should include the incremented (% style="color:#e74c3c" %)version(%%) number. 337 +|externalDependencies (default: false)|xs:boolean|(% style="width:737px" %)The externalDependencies [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the default resolution of external dependencies. This should be set to true if the repository is expected to use external reference URLs in the structural [[components>>doc:sdmx:Glossary.Component.WebHome]] to retrieve any externally referenced objects that is used by a non-external object. 317 317 318 318 Element Documentation: 319 319 320 - |**Name**|**Type**|**Documentation**|321 - 322 -|StructureLocation|xs:anyURI|StructureLocation provides the location of a SDMX-ML Structure message, external to the repository that can be retrieved by the repository submission service. |323 -|Structures|StructuresType|Structures allows for the inline definition of structural components for submission. |324 -|SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure contains a reference to one of the structural maintainable artefacts detailed in the external SDMX-ML Structure message or in-line and provides an override for the default action. This should only be used if the action to be performed on the referenced structural object is different than the default action. For example, one may want to append all structural components of a structure message, save one codelist. This codelist could be referenced in a submitted structure element and given an action of Informational.|341 +(% style="width:1080.29px" %) 342 +|**Name**|**Type**|(% style="width:734px" %)**Documentation** 343 +|StructureLocation|xs:anyURI|(% style="width:734px" %)StructureLocation provides the location of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message, external to the repository that can be retrieved by the repository submission service. 344 +|Structures|StructuresType|(% style="width:734px" %)Structures allows for the inline definition of structural [[components>>doc:sdmx:Glossary.Component.WebHome]] for submission. 345 +|SubmittedStructure|SubmittedStructureType|(% style="width:734px" %)SubmittedStructure contains a reference to one of the structural [[maintainable artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] detailed in the external [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message or in-line and provides an override for the default action. This should only be used if the action to be performed on the referenced structural object is different than the default action. For example, one may want to append all structural [[components>>doc:sdmx:Glossary.Component.WebHome]] of a structure message, save one [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. This [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] could be referenced in a submitted structure element and given an action of Informational. 325 325 326 -**SubmittedStructureType:** SubmittedStructureType generally references a submitted structural object. When used in a submit structure request, its purpose is to override the default action or external dependency resolution behavior. If neither of these indicators are set, then it will be ignored. In a submit structure response, it is used to reference a submitted object for the purpose of providing a status for the submission. In this case, the action attribute should be populated in order to echo the requested action. 347 +**SubmittedStructureType:** SubmittedStructureType generally references a submitted structural object. When used in a submit structure request, its purpose is to override the default action or external dependency resolution behavior. If neither of these indicators are set, then it will be ignored. In a submit structure response, it is used to reference a submitted object for the purpose of providing a status for the submission. In this case, the action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be populated in order to echo the requested action. 327 327 328 328 Attributes: 329 329 action?, externalDependencies? ... ... @@ -331,16 +331,18 @@ 331 331 Content: 332 332 MaintainableObject 333 333 334 -Attribute Documentation: 355 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 335 335 336 -|**Name**|**Type**|**Documentation**| 337 -|action|ActionType|The action attribute will indicate the action to be taken on the referenced structural object. This should be provided when this structure is used in a submit structure response.| 338 -|externalDependencies|xs:boolean|The externalDependencies attribute should be set to true if the repository is expected to use external reference URLs in the structural components to retrieve objects on which the referenced object has dependencies. (Thus, if a data structure referenced here is being submitted to the repository, and the structure message has URLs which point to the locations of the codelists it uses, then this attribute should be set to true). This should not be provided when this structure is used in a submit structure response.| 357 +(% style="width:1017.29px" %) 358 +|**Name**|**Type**|**Documentation** 359 +|action|ActionType|The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will indicate the action to be taken on the referenced structural object. This should be provided when this structure is used in a submit structure response. 360 +|externalDependencies|xs:boolean|The externalDependencies [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be set to true if the repository is expected to use external reference URLs in the structural [[components>>doc:sdmx:Glossary.Component.WebHome]] to retrieve objects on which the referenced object has dependencies. (Thus, if a data structure referenced here is being submitted to the repository, and the structure message has URLs which point to the locations of the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] it uses, then this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be set to true). This should not be provided when this structure is used in a submit structure response. 339 339 340 340 Element Documentation: 341 341 342 -|**Name**|**Type**|**Documentation**| 343 -|MaintainableObject|MaintainableUrnRefer enceType| | 364 +(% style="width:754.294px" %) 365 +|(% style="width:184px" %)**Name**|(% style="width:270px" %)**Type**|(% style="width:297px" %)**Documentation** 366 +|(% style="width:184px" %)MaintainableObject|(% style="width:270px" %)MaintainableUrnReferenceType|(% style="width:297px" %) 344 344 345 345 **SubmitStructureResponseType:** SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned. 346 346 ... ... @@ -349,8 +349,9 @@ 349 349 350 350 Element Documentation: 351 351 352 -|**Name**|**Type**|**Documentation**| 353 -|SubmissionResult|SubmissionResultType|SubmissionResult provides a status for each submitted structural object.| 375 +(% style="width:920.294px" %) 376 +|(% style="width:156px" %)**Name**|(% style="width:222px" %)**Type**|(% style="width:539px" %)**Documentation** 377 +|(% style="width:156px" %)SubmissionResult|(% style="width:222px" %)SubmissionResultType|(% style="width:539px" %)SubmissionResult provides a status for each submitted structural object. 354 354 355 355 **SubmissionResultType:** SubmissionResultType provides the status of the structural object submission request. It will identify the object submitted, report back the action requested, and convey the status and any error messages which are relevant to the submission. 356 356 ... ... @@ -359,11 +359,12 @@ 359 359 360 360 Element Documentation: 361 361 362 -|**Name**|**Type**|**Documentation**| 363 -|SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.| 364 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.| 386 +(% style="width:1022.29px" %) 387 +|**Name**|(% style="width:201px" %)**Type**|(% style="width:542px" %)**Documentation** 388 +|SubmittedStructure|(% style="width:201px" %)SubmittedStructureType|(% style="width:542px" %)SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it. 389 +|StatusMessage|(% style="width:201px" %)StatusMessageType|(% style="width:542px" %)StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information. 365 365 366 -**SubmitSubscriptionsRequestType:** SubmitSubscriptionsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of subscriptions. Subscriptions are submitted to the registry to subscribe to registration and change events for specific registry resources. 391 +**SubmitSubscriptionsRequestType:** SubmitSubscriptionsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]]. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] are submitted to the registry to subscribe to registration and change events for specific registry resources. 367 367 368 368 Content: 369 369 SubscriptionRequest+ ... ... @@ -370,10 +370,11 @@ 370 370 371 371 Element Documentation: 372 372 373 -|**Name**|**Type**|**Documentation**| 374 -|SubscriptionRequest|SubscriptionRequestT ype| | 398 +(% style="width:714.294px" %) 399 +|(% style="width:242px" %)**Name**|(% style="width:223px" %)**Type**|(% style="width:246px" %)**Documentation** 400 +|(% style="width:242px" %)SubscriptionRequest|(% style="width:223px" %)SubscriptionRequestType|(% style="width:246px" %) 375 375 376 -**SubscriptionType:** SubscriptionType describes the details of a subscription to a registration or change event for registry resources. When it occurs as the content of a response message, the registry URN must be provide, unless the response is a failure notification for the creation of a new subscription. 402 +**SubscriptionType:** SubscriptionType describes the details of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to a registration or change event for registry resources. When it occurs as the content of a response message, the registry URN must be provide, unless the response is a failure [[notification>>doc:sdmx:Glossary.Notification.WebHome]] for the creation of a new [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 377 377 378 378 Content: 379 379 Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector ... ... @@ -380,34 +380,37 @@ 380 380 381 381 Element Documentation: 382 382 383 -|**Name**|**Type**|**Documentation**| 384 -|Organisation|OrganisationReferenc eType|Organisation provides a reference to the organisation that owns this subscription. The reference is provided via a URN and/or a complete set of reference fields.| 385 -|RegistryURN|xs:anyURI|RegistryURN is used to identify the subscription in the case of deletion or modification. This should be provided in all response messages, unless the response it a notification of the failure to create a newly submitted subscription - in which case there will be no registry assigned URN.| 386 -|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single subscription.| 387 -|NotificationHTTP|NotificationURLType|NotificationHTTP holds an http address to which notifications can be addressed as POSTs. Multiple http address may be notified for a single subscription event.| 388 -|SubscriberAssignedID|IDType|SubscriberAssignedID allows the subscriber to specify an identification which will be returned as part of the notification for the subscribed events. This should be used if multiple new requests are made, so that the responses can be accurately correlated to the requests.| 389 -|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the subscription.| 390 -|EventSelector|EventSelectorType|EventSelector indicates an event or events for the subscription.| 409 +(% style="width:1056.29px" %) 410 +|**Name**|**Type**|**Documentation** 411 +|Organisation|OrganisationReferenceType|Organisation provides a reference to the organisation that owns this [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. The reference is provided via a URN and/or a complete set of reference fields. 412 +|RegistryURN|xs:anyURI|RegistryURN is used to identify the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the case of deletion or modification. This should be provided in all response messages, unless the response it a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] of the failure to create a newly submitted [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] - in which case there will be no registry assigned URN. 413 +|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 414 +|NotificationHTTP|NotificationURLType|NotificationHTTP holds an http address to which [[notifications>>doc:sdmx:Glossary.Notification.WebHome]] can be addressed as POSTs. Multiple http address may be notified for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] event. 415 +|SubscriberAssignedID|IDType|SubscriberAssignedID allows the subscriber to specify an identification which will be returned as part of the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] for the subscribed events. This should be used if multiple new requests are made, so that the responses can be accurately correlated to the requests. 416 +|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 417 +|EventSelector|EventSelectorType|EventSelector indicates an event or events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 391 391 392 -**SubscriptionRequestType:** SubscriptionRequestType describes the structure of a single subscription request. It contains subscription details and an action field to indicate the action to be taken on the contained subscription. Note that if the action is update or delete, then the registry supplied URN for the subscription must be included. 419 +**SubscriptionRequestType:** SubscriptionRequestType describes the structure of a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request. It contains [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] details and an action field to indicate the action to be taken on the contained [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. Note that if the action is update or delete, then the registry supplied URN for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] must be included. 393 393 394 394 Attributes: 395 395 action 396 396 397 397 Content: 398 -Subscription 425 +[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 399 399 400 -Attribute Documentation: 427 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 401 401 402 -|**Name**|**Type**|**Documentation**| 403 -|action|ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.| 429 +(% style="width:1118.29px" %) 430 +|**Name**|**Type**|(% style="width:753px" %)**Documentation** 431 +|action|ActionType|(% style="width:753px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this is an addition, a modification, or a deletion of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 404 404 405 405 Element Documentation: 406 406 407 -|**Name**|**Type**|**Documentation**| 408 -|Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.| 435 +(% style="width:1123.29px" %) 436 +|**Name**|**Type**|**Documentation** 437 +|[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|SubscriptionType|[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] contains the details of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to be added, updated, or deleted. 409 409 410 -**SubmitSubscriptionsResponseType:** SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request. 439 +**SubmitSubscriptionsResponseType:** SubmitSubscriptionsResponseType describes the structure of the response to a new [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] submission. A status is provided for each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the request. 411 411 412 412 Content: 413 413 SubscriptionStatus+ ... ... @@ -414,10 +414,11 @@ 414 414 415 415 Element Documentation: 416 416 417 -|**Name**|**Type**|**Documentation**| 418 -|SubscriptionStatus|SubscriptionStatusTy pe|SubscriptionStatus contains information which describes the success or failure of a subscription request, providing any error messages in the event of failure. The statuses should occur in the same order as the requests when responding to a message with multiple subscription requests. If a subscriber-assigned identification for the subscription is provided, it will be returned to allow for accurate matching of the responses to the requests. A registry assigned URN will be returned for any successfully created, updated, or deleted subscription.| 446 +(% style="width:1129.29px" %) 447 +|**Name**|**Type**|**Documentation** 448 +|SubscriptionStatus|SubscriptionStatusType|SubscriptionStatus contains information which describes the success or failure of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, providing any error messages in the event of failure. The statuses should occur in the same order as the requests when responding to a message with multiple [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] requests. If a subscriber-assigned identification for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is provided, it will be returned to allow for accurate matching of the responses to the requests. A registry assigned URN will be returned for any successfully created, updated, or deleted [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 419 419 420 -**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single subscription request. 450 +**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request. 421 421 422 422 Content: 423 423 SubscriptionURN?, SubscriberAssignedID?, StatusMessage ... ... @@ -424,12 +424,13 @@ 424 424 425 425 Element Documentation: 426 426 427 -|**Name**|**Type**|**Documentation**| 428 -|SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.| 429 -|SubscriberAssignedID|IDType|SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.| 430 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the subscription request, and if necessary, any error or warning information.| 457 +(% style="width:1154.29px" %) 458 +|**Name**|**Type**|(% style="width:676px" %)**Documentation** 459 +|SubscriptionURN|xs:anyURI|(% style="width:676px" %)SubscriptionURN contains the registry generated URN for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and will be returned for any successfully created, updated, or deleted [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 460 +|SubscriberAssignedID|IDType|(% style="width:676px" %)SubscriberAssignedID is the id assigned by the subscriber to the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. If it existed in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, it will be returned. 461 +|StatusMessage|StatusMessageType|(% style="width:676px" %)StatusMessage provides that status for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information. 431 431 432 -**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved. 463 +**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]]. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] for a given organisation may be retrieved. 433 433 434 434 Content: 435 435 Organisation ... ... @@ -436,10 +436,11 @@ 436 436 437 437 Element Documentation: 438 438 439 -|**Name**|**Type**|**Documentation**| 440 -|Organisation|OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.| 470 +(% style="width:1164.29px" %) 471 +|**Name**|**Type**|**Documentation** 472 +|Organisation|OrganisationReferenceType|Organisation provides a reference to the [[data consumer>>doc:sdmx:Glossary.Data consumer.WebHome]] for which the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] details should be returned. 441 441 442 -**QuerySubscriptionResponseType:** QuerySubscriptionResponseType describes the structure of a subscription query response. A status will describe the success or failure of the request (and provide error or warning messages if necessary). If the query was successful, details of all of the organisation's subscriptions will be provided. 474 +**QuerySubscriptionResponseType:** QuerySubscriptionResponseType describes the structure of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] query response. A status will describe the success or failure of the request (and provide error or warning messages if necessary). If the query was successful, details of all of the organisation's [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] will be provided. 443 443 444 444 Content: 445 445 StatusMessage, Subscription ... ... @@ -446,11 +446,12 @@ 446 446 447 447 Element Documentation: 448 448 449 -|**Name**|**Type**|**Documentation**| 450 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the query subscription request, and if necessary, any error or warning information.| 451 -|Subscription|SubscriptionType|Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.| 481 +(% style="width:1199.29px" %) 482 +|**Name**|**Type**|(% style="width:683px" %)**Documentation** 483 +|StatusMessage|StatusMessageType|(% style="width:683px" %)StatusMessage provides that status for the query [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information. 484 +|[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|SubscriptionType|(% style="width:683px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] contains the details of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] for the organisation. This may occur multiple times for each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 452 452 453 -**NotifyRegistryEventType:** NotifyRegistryEventType describes the structure a registry notification, in response to a subscription to a registry event. At a minimum, the event time, a reference to the change object, a reference to the underlying subscription triggering the notification, and the action that took place on the object are sent. In addition, the full details of the object may be provided at the discretion of the registry. In the event that the details are not sent, it will be possible to query for the details of the changed object using the reference provided. 486 +**NotifyRegistryEventType:** NotifyRegistryEventType describes the structure a registry [[notification>>doc:sdmx:Glossary.Notification.WebHome]], in response to a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to a registry event. At a minimum, the event time, a reference to the change object, a reference to the underlying [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] triggering the [[notification>>doc:sdmx:Glossary.Notification.WebHome]], and the action that took place on the object are sent. In addition, the full details of the object may be provided at the discretion of the registry. In the event that the details are not sent, it will be possible to query for the details of the changed object using the reference provided. 454 454 455 455 Content: 456 456 EventTime, (ObjectURN|RegistrationID), SubscriptionURN, EventAction, (StructuralEvent|RegistrationEvent)? ... ... @@ -457,16 +457,17 @@ 457 457 458 458 Element Documentation: 459 459 460 -|**Name**|**Type**|**Documentation**| 461 -|EventTime|xs:dateTime|EventTime specifies the time of the triggering event.| 462 -|ObjectURN|xs:anyURI|ObjectURN provides the URN of the object on which the event occurred, unless the event is related to a registration, in which case the RegistrationID element should be used.| 463 -|RegistrationID|IDType|RegistrationID provides the id of the registration that underwent an event.| 464 -|SubscriptionURN|xs:anyURI|SubscriptionURN provides the registry/repository URN of the subscription that is the cause of this notification being sent.| 465 -|EventAction|ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.| 466 -|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed.| 467 -|RegistrationEvent|RegistrationEventTyp e|RegistrationEvent is used to provide the details or the registration object that has changed.| 493 +(% style="width:1213.29px" %) 494 +|**Name**|**Type**|**Documentation** 495 +|EventTime|xs:dateTime|EventTime specifies the time of the triggering event. 496 +|ObjectURN|xs:anyURI|ObjectURN provides the URN of the object on which the event occurred, unless the event is related to a registration, in which case the RegistrationID element should be used. 497 +|RegistrationID|IDType|RegistrationID provides the id of the registration that underwent an event. 498 +|SubscriptionURN|xs:anyURI|SubscriptionURN provides the registry/repository URN of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] that is the cause of this [[notification>>doc:sdmx:Glossary.Notification.WebHome]] being sent. 499 +|EventAction|ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion. 500 +|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed. 501 +|RegistrationEvent|RegistrationEventType|RegistrationEvent is used to provide the details or the registration object that has changed. 468 468 469 -**NotificationURLType:** NotificationURLType describes the structure of an http or email address. The content holds the addresses while an attribute indicates whether or not is expects the contents in a SOAP message. 503 +**NotificationURLType:** NotificationURLType describes the structure of an http or email address. The content holds the addresses while an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether or not is expects the contents in a SOAP message. 470 470 471 471 Derivation: 472 472 ... ... @@ -478,12 +478,13 @@ 478 478 isSOAP? 479 479 480 480 Content: 481 -Attribute Documentation: 515 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 482 482 483 -|**Name**|**Type**|**Documentation**| 484 -|isSOAP (default: false)|xs:boolean|The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.| 517 +(% style="width:1068.29px" %) 518 +|**Name**|**Type**|**Documentation** 519 +|isSOAP (default:false)|xs:boolean|The isSOAP [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates the provided URL expects the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] to be sent in a SOAP message. 485 485 486 -**ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the subscription period. 521 +**ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] period. 487 487 488 488 Content: 489 489 StartDate, EndDate ... ... @@ -490,23 +490,26 @@ 490 490 491 491 Element Documentation: 492 492 493 -|**Name**|**Type**|**Documentation**| 494 -|StartDate|xs:date|StartDate is an inclusive start date for the subscription.| 495 -|EndDate|xs:date|EndDate is an inclusive end date for the subscription.| 528 +(% style="width:1052.29px" %) 529 +|**Name**|**Type**|**Documentation** 530 +|StartDate|xs:date|StartDate is an inclusive start date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 531 +|EndDate|xs:date|EndDate is an inclusive end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 496 496 497 -**EventSelectorType:** EventSelectorType describes the details of the events for a subscription. It allows subscribers to specify registry and repository events for which they wish to receive notifications. 533 +**EventSelectorType:** EventSelectorType describes the details of the events for a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. It allows subscribers to specify registry and repository events for which they wish to receive notifications. 498 498 499 499 Content: 536 + 500 500 (StructuralRepositoryEvents|DataRegistrationEvents|MetadataRegistrationEvents)[1..3] 501 501 502 502 Element Documentation: 503 503 504 -|**Name**|**Type**|**Documentation**| 505 -|StructuralRepository Events|StructuralRepository EventsType|StructuralRepositoryEvents details structural events for the subscription.| 506 -|DataRegistrationEven ts|DataRegistrationEven tsType|DataRegistrationEvents details the data registration events for the subscription.| 507 -|MetadataRegistration Events|MetadataRegistration EventsType|MetadataRegistrationEvents details the metadata registration events for the subscription.| 541 +(% style="width:1053.29px" %) 542 +|(% style="width:275px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:495px" %)**Documentation** 543 +|(% style="width:275px" %)StructuralRepositoryEvents|(% style="width:281px" %)StructuralRepositoryEventsType|(% style="width:495px" %)StructuralRepositoryEvents details structural events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 544 +|(% style="width:275px" %)DataRegistrationEvents|(% style="width:281px" %)DataRegistrationEventsType|(% style="width:495px" %)DataRegistrationEvents details the data registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 545 +|(% style="width:275px" %)MetadataRegistration Events|(% style="width:281px" %)MetadataRegistrationEventsType|(% style="width:495px" %)MetadataRegistrationEvents details the metadata registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 508 508 509 -**StructuralRepositoryEventsType:** StructuralRepositoryEventsType details the structural events for the subscription. At least one maintenance agency must be specified, although it may be given a wildcard value (meaning the subscription is for the structural events of all agencies). This can also be a list of agencies to allow the subscription to subscribe the events of more than one agency. It should be noted that when doing so, all of the subsequent objects are assumed to apply to every agency in the list. The subscription is then refined by detailing the structural objects maintained by the agency for which the subscription should apply. It is possible to explicitly select all object events, all objects of given types, or to individually list out specific objects. Note that for any object, it is also possible to provide an explicit URN to reference a distinct object. In this case, the reference to maintenance agency described above is ignored. Although it is not required, if specific objects are being referenced by explicit URNs, it is good practice to list the agencies. 547 +**StructuralRepositoryEventsType:** StructuralRepositoryEventsType details the structural events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. At least one [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] must be specified, although it may be given a wildcard value (meaning the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is for the structural events of all agencies). This can also be a list of agencies to allow the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to subscribe the events of more than one agency. It should be noted that when doing so, all of the subsequent objects are assumed to apply to every agency in the list. The [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is then refined by detailing the structural objects maintained by the agency for which the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] should apply. It is possible to explicitly select all object events, all objects of given types, or to individually list out specific objects. Note that for any object, it is also possible to provide an explicit URN to reference a distinct object. In this case, the reference to [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] described above is ignored. Although it is not required, if specific objects are being referenced by explicit URNs, it is good practice to list the agencies. 510 510 511 511 Attributes: 512 512 TYPE?