Changes for page Part II.Common Namespace
Last modified by Elena Yasinovskaya on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -144,29 +144,29 @@ 144 144 xs:string (extension) 145 145 TextType 146 146 147 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:147 +Attributes: 148 148 xml:lang? 149 149 150 150 Content: 151 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:151 +Attribute Documentation: 152 152 153 153 (% style="width:1005.29px" %) 154 154 |**Name**|**Type**|(% style="width:519px" %)**Documentation** 155 -|xml:lang (default: en)|xs:language|(% style="width:519px" %)The xml:lang [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]specifies a language[[code>>doc:sdmx:Glossary.Code.WebHome]]for the text. If not supplied, the default language is assumed to be English.155 +|xml:lang (default: en)|xs:language|(% style="width:519px" %)The xml:lang attribute specifies a language code for the text. If not supplied, the default language is assumed to be English. 156 156 157 -**StatusMessageType:** StatusMessageType describes the structure of an error or warning message. A message contains the text of the message, as well as an optional language indicator and an optional [[code>>doc:sdmx:Glossary.Code.WebHome]].157 +**StatusMessageType:** StatusMessageType describes the structure of an error or warning message. A message contains the text of the message, as well as an optional language indicator and an optional code. 158 158 159 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:160 - [[code>>doc:sdmx:Glossary.Code.WebHome]]?159 +Attributes: 160 +code? 161 161 162 162 Content: 163 163 Text+ 164 164 165 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:165 +Attribute Documentation: 166 166 167 167 (% style="width:1010.29px" %) 168 168 |**Name**|**Type**|(% style="width:867px" %)**Documentation** 169 -| [[code>>doc:sdmx:Glossary.Code.WebHome]]|xs:string|(% style="width:867px" %)The[[code>>doc:sdmx:Glossary.Code.WebHome]][[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds an optional[[code>>doc:sdmx:Glossary.Code.WebHome]]identifying the underlying error that generated the message. This should be used if parallel language descriptions of the error are supplied, to distinguish which of the multiple error messages are for the same underlying error.169 +|code|xs:string|(% style="width:867px" %)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. 170 170 171 171 Element Documentation: 172 172 ... ... @@ -179,7 +179,7 @@ 179 179 Content: 180 180 {Empty} 181 181 182 -**CodedStatusMessageType:** CodedStatusMessageType describes the structure of an error or warning message which required a [[code>>doc:sdmx:Glossary.Code.WebHome]].182 +**CodedStatusMessageType:** CodedStatusMessageType describes the structure of an error or warning message which required a code. 183 183 184 184 Derivation: 185 185 ... ... @@ -186,17 +186,17 @@ 186 186 StatusMessageType (restriction) 187 187 CodedStatusMessageType 188 188 189 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:190 - [[code>>doc:sdmx:Glossary.Code.WebHome]]189 +Attributes: 190 +code 191 191 192 192 Content: 193 193 Text+ 194 194 195 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:195 +Attribute Documentation: 196 196 197 197 (% style="width:1011.29px" %) 198 198 |(% style="width:152px" %)**Name**|(% style="width:182px" %)**Type**|(% style="width:675px" %)**Documentation** 199 -|(% style="width:152px" %) [[code>>doc:sdmx:Glossary.Code.WebHome]]|(% style="width:182px" %)xs:string|(% style="width:675px" %)The[[code>>doc:sdmx:Glossary.Code.WebHome]][[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds an optional[[code>>doc:sdmx:Glossary.Code.WebHome]]identifying the underlying error that generated the message. This should be used if parallel language descriptions of the error are supplied, to distinguish which of the multiple error messages are for the same underlying error.199 +|(% style="width:152px" %)code|(% style="width:182px" %)xs:string|(% style="width:675px" %)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. 200 200 201 201 Element Documentation: 202 202 ... ... @@ -204,51 +204,51 @@ 204 204 |(% style="width:150px" %)**Name**|(% style="width:206px" %)**Type**|(% style="width:652px" %)**Documentation** 205 205 |(% style="width:150px" %)Text|(% style="width:206px" %)TextType|(% style="width:652px" %)Text contains the text of the message, in parallel language values. 206 206 207 - //**AnnotableType:**//AnnotableType is an abstract base type used for all[[annotable artefacts>>doc:sdmx:Glossary.Annotableartefact.WebHome]].Any type that provides for[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]should extend this type.207 +***AnnotableType*:** AnnotableType is an abstract base type used for all annotable artefacts. Any type that provides for annotations should extend this type. 208 208 209 209 Content: 210 - [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?210 +Annotations? 211 211 212 212 Element Documentation: 213 213 214 214 (% style="width:1014.29px" %) 215 215 |**Name**|**Type**|(% style="width:683px" %)**Documentation** 216 -| [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|(% style="width:683px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType may reference it.216 +|Annotations|AnnotationsType|(% style="width:683px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 217 217 218 -**AnnotationsType:** AnnotationsType provides for a list of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]to be attached to data and structure messages.218 +**AnnotationsType:** AnnotationsType provides for a list of annotations to be attached to data and structure messages. 219 219 220 220 Content: 221 - [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]+221 +Annotation+ 222 222 223 223 Element Documentation: 224 224 225 225 (% style="width:1019.29px" %) 226 226 |(% style="width:230px" %)**Name**|(% style="width:222px" %)**Type**|(% style="width:564px" %)**Documentation** 227 -|(% style="width:230px" %) [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|(% style="width:222px" %)AnnotationType|(% style="width:564px" %)227 +|(% style="width:230px" %)Annotation|(% style="width:222px" %)AnnotationType|(% style="width:564px" %) 228 228 229 -**AnnotationType:** AnnotationType provides for non-documentation notes and [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]to be embedded in data and structure messages. It provides optional fields for providing a[[title>>doc:sdmx:Glossary.Title.WebHome]], a type description, a URI, and the text of the[[annotation>>doc:sdmx:Glossary.Annotation.WebHome]].229 +**AnnotationType:** AnnotationType provides for non-documentation notes and annotations to be embedded in data and structure messages. It provides optional fields for providing a title, a type description, a URI, and the text of the annotation. 230 230 231 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:231 +Attributes: 232 232 id? 233 233 234 234 Content: 235 235 AnnotationTitle?, AnnotationType?, AnnotationURL*, AnnotationText*, AnnotationValue? 236 236 237 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:237 +Attribute Documentation: 238 238 239 239 (% style="width:994.294px" %) 240 240 |**Name**|**Type**|(% style="width:697px" %)**Documentation** 241 -|id|xs:string|(% style="width:697px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides a non-standard identification of an[[annotation>>doc:sdmx:Glossary.Annotation.WebHome]].It can be used to disambiguate[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].241 +|id|xs:string|(% style="width:697px" %)The id attribute provides a non-standard identification of an annotation. It can be used to disambiguate annotations. 242 242 243 243 Element Documentation: 244 244 245 245 (% style="width:1005.29px" %) 246 246 |**Name**|**Type**|(% style="width:710px" %)**Documentation** 247 -|AnnotationTitle|xs:string|(% style="width:710px" %)AnnotationTitle provides a [[title>>doc:sdmx:Glossary.Title.WebHome]]for the[[annotation>>doc:sdmx:Glossary.Annotation.WebHome]].248 -|AnnotationType|xs:string|(% style="width:710px" %)AnnotationType is used to distinguish between [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]designed to support various uses. The types are not enumerated, as these can be specified by the user or creator of the[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].The definitions and use of[[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]types should be documented by their creator.249 -|AnnotationURL|AnnotationURLType|(% style="width:710px" %)AnnotationURL is a URI - typically a URL - which points to an external resource which may contain or supplement the [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]].These can be localised by indicating a language for the resource. If a language is not specified, the resource is assumed to not be localised. If a specific behavior is desired, an[[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]type should be defined which specifies the use of this field more exactly.250 -|AnnotationText|TextType|(% style="width:710px" %)AnnotationText holds a language-specific string containing the text of the [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]].251 -|AnnotationValue|xs:string|(% style="width:710px" %)AnnotationValue holds a non-localised value for the [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]].247 +|AnnotationTitle|xs:string|(% style="width:710px" %)AnnotationTitle provides a title for the annotation. 248 +|AnnotationType|xs:string|(% style="width:710px" %)AnnotationType is used to distinguish between annotations designed to support various uses. The types are not enumerated, as these can be specified by the user or creator of the annotations. The definitions and use of annotation types should be documented by their creator. 249 +|AnnotationURL|AnnotationURLType|(% style="width:710px" %)AnnotationURL is a URI - typically a URL - which points to an external resource which may contain or supplement the annotation. These can be localised by indicating a language for the resource. If a language is not specified, the resource is assumed to not be localised. If a specific behavior is desired, an annotation type should be defined which specifies the use of this field more exactly. 250 +|AnnotationText|TextType|(% style="width:710px" %)AnnotationText holds a language-specific string containing the text of the annotation. 251 +|AnnotationValue|xs:string|(% style="width:710px" %)AnnotationValue holds a non-localised value for the annotation. 252 252 253 253 **AnnotationURLType:** AnnotationURLType defines an external resource. These can indicate localisation by specifying a language for the resource. 254 254 ... ... @@ -258,11 +258,11 @@ 258 258 xs:anyURI (extension) 259 259 AnnotationURLType 260 260 261 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:261 +Attributes: 262 262 xml:lang? 263 263 264 264 Content: 265 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:265 +Attribute Documentation: 266 266 267 267 (% style="width:1004.29px" %) 268 268 |**Name**|**Type**|(% style="width:639px" %)**Documentation** ... ... @@ -270,20 +270,20 @@ 270 270 271 271 **LinkType:** 272 272 273 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:273 +Attributes: 274 274 rel, url, urn?, type? 275 275 276 276 Content: 277 277 {Empty} 278 278 279 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:279 +Attribute Documentation: 280 280 281 281 (% style="width:1000.29px" %) 282 282 |(% style="width:147px" %)**Name**|(% style="width:249px" %)**Type**|(% style="width:602px" %)**Documentation** 283 283 |(% style="width:147px" %)rel|(% style="width:249px" %)xs:string|(% style="width:602px" %)The type of object that is being linked to. 284 284 |(% style="width:147px" %)url|(% style="width:249px" %)xs:anyURI|(% style="width:602px" %)The url of the object being linked. 285 -|(% style="width:147px" %)urn|(% style="width:249px" %)xs:anyURI|(% style="width:602px" %)A [[SDMX registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]urn of the object being linked (if applicable).286 -|(% style="width:147px" %)type|(% style="width:249px" %)xs:string|(% style="width:602px" %)The type of link (e.g. PDF, text, HTML, [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]).285 +|(% style="width:147px" %)urn|(% style="width:249px" %)xs:anyURI|(% style="width:602px" %)A SDMX registry urn of the object being linked (if applicable). 286 +|(% style="width:147px" %)type|(% style="width:249px" %)xs:string|(% style="width:602px" %)The type of link (e.g. PDF, text, HTML, reference metadata). 287 287 288 288 **//IdentifiableType//:** IdentifiableType is an abstract base type for all identifiable objects. 289 289 ... ... @@ -292,26 +292,26 @@ 292 292 AnnotableType (extension) 293 293 IdentifiableType* 294 294 295 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:295 +Attributes: 296 296 id?, urn?, uri? 297 297 298 298 Content: 299 - [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link299 +Annotations?, Link 300 300 301 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:301 +Attribute Documentation: 302 302 303 303 (% style="width:1002.29px" %) 304 304 |**Name**|**Type**|(% style="width:753px" %)**Documentation** 305 305 |id|IDType|(% style="width:753px" %)The id is the identifier for the object. 306 -|urn|UrnType|(% style="width:753px" %)The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a valid[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]URN (see[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]Specification for details).307 -|uri|xs:anyURI|(% style="width:753px" %)The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a[[SDMX>>doc:sdmx:Glossary.Statisticaldata andmetadata exchange.WebHome]] message.306 +|urn|UrnType|(% style="width:753px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). 307 +|uri|xs:anyURI|(% style="width:753px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. 308 308 309 309 Element Documentation: 310 310 311 311 (% style="width:1002.29px" %) 312 312 |**Name**|**Type**|(% style="width:725px" %)**Documentation** 313 -| [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|(% style="width:725px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType may reference it.314 -|Link|LinkType|(% style="width:725px" %)Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.313 +|Annotations|AnnotationsType|(% style="width:725px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 314 +|Link|LinkType|(% style="width:725px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. 315 315 316 316 //**NameableType:**// NameableType is an abstract base type for all nameable objects. 317 317 ... ... @@ -321,26 +321,26 @@ 321 321 IdentifiableType (extension) 322 322 NameableType* 323 323 324 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:324 +Attributes: 325 325 id?, urn?, uri? 326 326 327 327 Content: 328 - [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description328 +Annotations?, Link*, Name+, Description 329 329 330 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:330 +Attribute Documentation: 331 331 332 332 (% style="width:1012.29px" %) 333 333 |**Name**|**Type**|(% style="width:768px" %)**Documentation** 334 334 |id|IDType|(% style="width:768px" %)The id is the identifier for the object. 335 -|urn|UrnType|(% style="width:768px" %)The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a valid[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]URN (see[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]Specification for details).336 -|uri|xs:anyURI|(% style="width:768px" %)The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a[[SDMX>>doc:sdmx:Glossary.Statisticaldata andmetadata exchange.WebHome]] message.335 +|urn|UrnType|(% style="width:768px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). 336 +|uri|xs:anyURI|(% style="width:768px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. 337 337 338 338 Element Documentation: 339 339 340 340 (% style="width:1008.29px" %) 341 341 |**Name**|**Type**|(% style="width:731px" %)**Documentation** 342 -| [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|(% style="width:731px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType may reference it.343 -|Link|LinkType|(% style="width:731px" %)Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.342 +|Annotations|AnnotationsType|(% style="width:731px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 343 +|Link|LinkType|(% style="width:731px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. 344 344 |Name|TextType|(% style="width:731px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. 345 345 |Description|TextType|(% style="width:731px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. 346 346 ... ... @@ -353,33 +353,33 @@ 353 353 NameableType (extension) 354 354 VersionableType* 355 355 356 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:357 -id?, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?356 +Attributes: 357 +id?, urn?, uri?, version?, validFrom?, validTo? 358 358 359 359 Content: 360 - [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description360 +Annotations?, Link*, Name+, Description 361 361 362 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:362 +Attribute Documentation: 363 363 364 364 (% style="width:1000.29px" %) 365 365 |**Name**|**Type**|(% style="width:700px" %)**Documentation** 366 366 |id|IDType|(% style="width:700px" %)The id is the identifier for the object. 367 -|urn|UrnType|(% style="width:700px" %)The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a valid[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]URN (see[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]Specification for details).368 -|uri|xs:anyURI|(% style="width:700px" %)The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a[[SDMX>>doc:sdmx:Glossary.Statisticaldata andmetadata exchange.WebHome]] message.369 -| (%%)(% style="color:#e74c3c" %)version|VersionType|(% style="width:700px" %)This(% style="color:#e74c3c" %)version(%%)[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a(% style="color:#e74c3c" %)version(%%)number (see common:VersionType definition for details). If not supplied,[[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]is considered to be un-versioned.370 -|validFrom|xs:dateTime|(% style="width:700px" %)The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides the inclusive start date for providing supplemental validity information about the(% style="color:#e74c3c" %)version(%%).371 -|validTo|xs:dateTime|(% style="width:700px" %)The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides the inclusive end date for providing supplemental validity information about the(% style="color:#e74c3c" %)version(%%).367 +|urn|UrnType|(% style="width:700px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). 368 +|uri|xs:anyURI|(% style="width:700px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. 369 +|version|VersionType|(% style="width:700px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. 370 +|validFrom|xs:dateTime|(% style="width:700px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. 371 +|validTo|xs:dateTime|(% style="width:700px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. 372 372 373 373 Element Documentation: 374 374 375 375 (% style="width:1004.29px" %) 376 376 |**Name**|**Type**|(% style="width:727px" %)**Documentation** 377 -| [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|(% style="width:727px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType may reference it.378 -|Link|LinkType|(% style="width:727px" %)Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.377 +|Annotations|AnnotationsType|(% style="width:727px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 378 +|Link|LinkType|(% style="width:727px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. 379 379 |Name|TextType|(% style="width:727px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. 380 380 |Description|TextType|(% style="width:727px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. 381 381 382 -//**MaintainableBaseType:**// MaintainableBaseType is an abstract type that only serves the purpose of forming the base for the actual MaintainableType. The purpose of this type is to restrict the VersionableType to require the id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].382 +//**MaintainableBaseType:**// MaintainableBaseType is an abstract type that only serves the purpose of forming the base for the actual MaintainableType. The purpose of this type is to restrict the VersionableType to require the id attribute. 383 383 384 384 Derivation: 385 385 ... ... @@ -389,29 +389,29 @@ 389 389 VersionableType (restriction) 390 390 MaintainableBaseType* 391 391 392 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:393 -id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?392 +Attributes: 393 +id, urn?, uri?, version?, validFrom?, validTo? 394 394 395 395 Content: 396 - [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description396 +Annotations?, Link*, Name+, Description 397 397 398 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:398 +Attribute Documentation: 399 399 400 400 (% style="width:1004.29px" %) 401 401 |**Name**|**Type**|(% style="width:625px" %)**Documentation** 402 402 |id|IDType|(% style="width:625px" %)The id is the identifier for the object. 403 -|urn|MaintainableUrnType|(% style="width:625px" %)The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a valid[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]URN (see[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]Specification for details).404 -|uri|xs:anyURI|(% style="width:625px" %)The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a[[SDMX>>doc:sdmx:Glossary.Statisticaldata andmetadata exchange.WebHome]] message.405 -| (%%)(% style="color:#e74c3c" %)version|VersionType|(% style="width:625px" %)This(% style="color:#e74c3c" %)version(%%)[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a(% style="color:#e74c3c" %)version(%%)number (see common:VersionType definition for details). If not supplied,[[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]is considered to be un-versioned.406 -|validFrom|xs:dateTime|(% style="width:625px" %)The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides the inclusive start date for providing supplemental validity information about the(% style="color:#e74c3c" %)version(%%).407 -|validTo|xs:dateTime|(% style="width:625px" %)The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides the inclusive end date for providing supplemental validity information about the(% style="color:#e74c3c" %)version(%%).403 +|urn|MaintainableUrnType|(% style="width:625px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). 404 +|uri|xs:anyURI|(% style="width:625px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. 405 +|version|VersionType|(% style="width:625px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. 406 +|validFrom|xs:dateTime|(% style="width:625px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. 407 +|validTo|xs:dateTime|(% style="width:625px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. 408 408 409 409 Element Documentation: 410 410 411 411 (% style="width:1005.29px" %) 412 412 |**Name**|**Type**|(% style="width:728px" %)**Documentation** 413 -| [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|(% style="width:728px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType may reference it.414 -|Link|LinkType|(% style="width:728px" %)Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.413 +|Annotations|AnnotationsType|(% style="width:728px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 414 +|Link|LinkType|(% style="width:728px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. 415 415 |Name|TextType|(% style="width:728px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. 416 416 |Description|TextType|(% style="width:728px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. 417 417 ... ... @@ -426,74 +426,74 @@ 426 426 MaintainableBaseType (extension) 427 427 MaintainableType* 428 428 429 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:430 -id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?,[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?429 +Attributes: 430 +id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? 431 431 432 432 Content: 433 - [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description433 +Annotations?, Link*, Name+, Description 434 434 435 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:435 +Attribute Documentation: 436 436 437 437 (% style="width:1005.29px" %) 438 438 |**Name**|**Type**|(% style="width:623px" %)**Documentation** 439 439 |id|IDType|(% style="width:623px" %)The id is the identifier for the object. 440 -|urn|MaintainableUrnType|(% style="width:623px" %)The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a valid[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]URN (see[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]Specification for details).441 -|uri|xs:anyURI|(% style="width:623px" %)The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a[[SDMX>>doc:sdmx:Glossary.Statisticaldata andmetadata exchange.WebHome]] message.442 -| (%%)(% style="color:#e74c3c" %)version|VersionType|(% style="width:623px" %)This(% style="color:#e74c3c" %)version(%%)[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds a(% style="color:#e74c3c" %)version(%%)number (see common:VersionType definition for details). If not supplied,[[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]is considered to be un-versioned.443 -|validFrom|xs:dateTime|(% style="width:623px" %)The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides the inclusive start date for providing supplemental validity information about the(% style="color:#e74c3c" %)version(%%).444 -|validTo|xs:dateTime|(% style="width:623px" %)The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides the inclusive end date for providing supplemental validity information about the(% style="color:#e74c3c" %)version(%%).445 -|agencyID|NestedNCNameIDType|(% style="width:623px" %)The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenanceagency.WebHome]] of the object.446 -| [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]](default: false)|xs:boolean|(% style="width:623px" %)The[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]][[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]][[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.447 -|serviceURL|xs:anyURI|(% style="width:623px" %)The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the URL of an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]repository, as they both implement that same web service interface.448 -|structureURL|xs:anyURI|(% style="width:623px" %)The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the URL of a[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]structure message (in the same(% style="color:#e74c3c" %)version(%%)as the source document) in which the externally referenced object is contained. Note that this may be a URL of an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]RESTful web service which will return the referenced object.449 -|isPartialLanguage (default: false)|xs:boolean|(% style="width:623px" %)The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.440 +|urn|MaintainableUrnType|(% style="width:623px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). 441 +|uri|xs:anyURI|(% style="width:623px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. 442 +|version|VersionType|(% style="width:623px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. 443 +|validFrom|xs:dateTime|(% style="width:623px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. 444 +|validTo|xs:dateTime|(% style="width:623px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. 445 +|agencyID|NestedNCNameIDType|(% style="width:623px" %)The agencyID must be provided, and identifies the maintenance agency of the object. 446 +|isExternalReference (default: false)|xs:boolean|(% style="width:623px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. 447 +|serviceURL|xs:anyURI|(% style="width:623px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. 448 +|structureURL|xs:anyURI|(% style="width:623px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. 449 +|isPartialLanguage (default: false)|xs:boolean|(% style="width:623px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. 450 450 451 451 Element Documentation: 452 452 453 453 (% style="width:1004.29px" %) 454 454 |**Name**|**Type**|(% style="width:727px" %)**Documentation** 455 -| [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|(% style="width:727px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType may reference it.456 -|Link|LinkType|(% style="width:727px" %)Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.455 +|Annotations|AnnotationsType|(% style="width:727px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 456 +|Link|LinkType|(% style="width:727px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. 457 457 |Name|TextType|(% style="width:727px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. 458 458 |Description|TextType|(% style="width:727px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. 459 459 460 460 **ReferencePeriodType:** Specifies the inclusive start and end times. 461 461 462 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:462 +Attributes: 463 463 startTime, endTime 464 464 465 465 Content: 466 466 {Empty} 467 467 468 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:468 +Attribute Documentation: 469 469 470 470 (% style="width:995.294px" %) 471 471 |(% style="width:145px" %)**Name**|(% style="width:216px" %)**Type**|(% style="width:632px" %)**Documentation** 472 -|(% style="width:145px" %)startTime|(% style="width:216px" %)xs:dateTime|(% style="width:632px" %)The startTime [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the inclusive start date for the reference period.473 -|(% style="width:145px" %)endTime|(% style="width:216px" %)xs:dateTime|(% style="width:632px" %)The endTime [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the inclusive end date for the reference period.472 +|(% style="width:145px" %)startTime|(% style="width:216px" %)xs:dateTime|(% style="width:632px" %)The startTime attributes contains the inclusive start date for the reference period. 473 +|(% style="width:145px" %)endTime|(% style="width:216px" %)xs:dateTime|(% style="width:632px" %)The endTime attributes contains the inclusive end date for the reference period. 474 474 475 -**QueryableDataSourceType:** QueryableDataSourceType describes a [[data source>>doc:sdmx:Glossary.Datasource.WebHome]]which is accepts an standard[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]Query message and responds appropriately.475 +**QueryableDataSourceType:** QueryableDataSourceType describes a data source which is accepts an standard SDMX Query message and responds appropriately. 476 476 477 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:477 +Attributes: 478 478 isRESTDatasource, isWebServiceDatasource 479 479 480 480 Content: 481 481 DataURL, WSDLURL?, WADLURL? 482 482 483 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:483 +Attribute Documentation: 484 484 485 485 (% style="width:999.294px" %) 486 486 |(% style="width:259px" %)**Name**|(% style="width:236px" %)**Type**|(% style="width:502px" %)**Documentation** 487 -|(% style="width:259px" %)isRESTDatasource|(% style="width:236px" %)xs:boolean|(% style="width:502px" %)The isRESTDatasource [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates, if true, that the queryable[[data source>>doc:sdmx:Glossary.Datasource.WebHome]]is accessible via the REST protocol.488 -|(% style="width:259px" %)isWebServiceDatasource|(% style="width:236px" %)xs:boolean|(% style="width:502px" %)The isWebServiceDatasource [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates, if true, that the queryable[[data source>>doc:sdmx:Glossary.Datasource.WebHome]]is accessible via Web Services protocols.487 +|(% style="width:259px" %)isRESTDatasource|(% style="width:236px" %)xs:boolean|(% style="width:502px" %)The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol. 488 +|(% style="width:259px" %)isWebServiceDatasource|(% style="width:236px" %)xs:boolean|(% style="width:502px" %)The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols. 489 489 490 490 Element Documentation: 491 491 492 492 (% style="width:996.294px" %) 493 493 |**Name**|**Type**|(% style="width:657px" %)**Documentation** 494 -|DataURL|xs:anyURI|(% style="width:657px" %)DataURL contains the URL of the [[data source>>doc:sdmx:Glossary.Data source.WebHome]].495 -|WSDLURL|xs:anyURI|(% style="width:657px" %)WSDLURL provides the location of a WSDL instance on the internet which describes the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]].496 -|WADLURL|xs:anyURI|(% style="width:657px" %)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]].494 +|DataURL|xs:anyURI|(% style="width:657px" %)DataURL contains the URL of the data source. 495 +|WSDLURL|xs:anyURI|(% style="width:657px" %)WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source. 496 +|WADLURL|xs:anyURI|(% style="width:657px" %)WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source. 497 497 498 498 **XHTMLType:** XHTMLType allows for mixed content of text and XHTML tags. When using this type, one will have to provide a reference to the XHTML schema, since the processing of the tags within this type is strict, meaning that they are validated against the XHTML schema provided. 499 499 ... ... @@ -509,7 +509,7 @@ 509 509 |(% style="width:228px" %)**Name**|(% style="width:221px" %)**Type**|(% style="width:699px" %)**Documentation** 510 510 |(% style="width:228px" %)xml:lang (default: en)|(% style="width:221px" %)xs:language 511 511 512 - //**PayloadStructureType:**//PayloadStructureType is an abstract base type used to define the structural information for data or[[metadata sets>>doc:sdmx:Glossary.Metadataset.WebHome]].A reference to the structure is provided (either explicitly or through a reference to a structure usage).512 +***PayloadStructureType*:** PayloadStructureType is an abstract base type used to define the structural information for data or metadata sets. A reference to the structure is provided (either explicitly or through a reference to a structure usage). 513 513 514 514 Attributes: 515 515 structureID, schemaURL?, namespace?, dimensionAtObservation?, explicitMeasures?, serviceURL?, structureURL? ... ... @@ -517,27 +517,27 @@ 517 517 Content: 518 518 (ProvisionAgreement|StructureUsage|Structure) 519 519 520 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:520 +Attribute Documentation: 521 521 522 522 (% style="width:1003.29px" %) 523 523 |**Name**|**Type**|(% style="width:598px" %)**Documentation** 524 -|structureID|xs:ID|(% style="width:598px" %)The structureID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]is present in the message.525 -|schemaURL|xs:anyURI|(% style="width:598px" %)The schemaURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides a location from which the structure specific schema can be located.526 -|namespace|xs:anyURI|(% style="width:598px" %)The namespace [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.527 -|dimensionAtObservation|ObservationDimensionType|(% style="width:598px" %)The dimensionAtObservation is used to reference the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.528 -|explicitMeasures|xs:boolean|(% style="width:598px" %)The explicitMeasures indicates whether explicit [[measures>>doc:sdmx:Glossary.Measure.WebHome]]are used in the cross sectional format. This is only applicable for the[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]as the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)or the flat structure.529 -|serviceURL|xs:anyURI|(% style="width:598px" %)The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the URL of an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]repository, as they both implement that same web service interface.530 -|structureURL|xs:anyURI|(% style="width:598px" %)The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the URL of a[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]structure message (in the same(% style="color:#e74c3c" %)version(%%)as the source document) in which the externally referenced object is contained. Note that this may be a URL of an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]RESTful web service which will return the referenced object.524 +|structureID|xs:ID|(% style="width:598px" %)The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message. 525 +|schemaURL|xs:anyURI|(% style="width:598px" %)The schemaURL attribute provides a location from which the structure specific schema can be located. 526 +|namespace|xs:anyURI|(% style="width:598px" %)The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message. 527 +|dimensionAtObservation|ObservationDimensionType|(% style="width:598px" %)The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format. 528 +|explicitMeasures|xs:boolean|(% style="width:598px" %)The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure. 529 +|serviceURL|xs:anyURI|(% style="width:598px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. 530 +|structureURL|xs:anyURI|(% style="width:598px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. 531 531 532 532 Element Documentation: 533 533 534 534 (% style="width:1005.29px" %) 535 535 |(% style="width:188px" %)**Name**|(% style="width:287px" %)**Type**|(% style="width:527px" %)**Documentation** 536 -|(% style="width:188px" %)ProvisionAgreement|(% style="width:287px" %)ProvisionAgreementReferenceType|(% style="width:527px" %)ProvisionAgreement references a [[provision agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]]which the data or metadata is reported against.536 +|(% style="width:188px" %)ProvisionAgreement|(% style="width:287px" %)ProvisionAgreementReferenceType|(% style="width:527px" %)ProvisionAgreement references a provision agreement which the data or metadata is reported against. 537 537 |(% style="width:188px" %)StructureUsage|(% style="width:287px" %)StructureUsageReferenceType|(% style="width:527px" %)StructureUsage references a flow which the data or metadata is reported against. 538 538 |(% style="width:188px" %)Structure|(% style="width:287px" %)StructureReferenceType|(% style="width:527px" %)Structure references the structure which defines the structure of the data or metadata set. 539 539 540 -//**DataStructureType:**// DataStructureType is an abstract base type the forms the basis for the structural information for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]].540 +//**DataStructureType:**// DataStructureType is an abstract base type the forms the basis for the structural information for a data set. 541 541 542 542 Derivation: 543 543 ... ... @@ -550,27 +550,27 @@ 550 550 Content: 551 551 (ProvisionAgreement | StructureUsage | Structure) 552 552 553 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:553 +Attribute Documentation: 554 554 555 555 (% style="width:1006.29px" %) 556 556 |**Name**|**Type**|(% style="width:598px" %)**Documentation** 557 -|structureID|xs:ID|(% style="width:598px" %)The structureID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]is present in the message.558 -|schemaURL|xs:anyURI|(% style="width:598px" %)The schemaURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides a location from which the structure specific schema can be located.559 -|namespace|xs:anyURI|(% style="width:598px" %)The namespace [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.560 -|dimensionAtObservation|ObservationDimensionType|(% style="width:598px" %)The dimensionAtObservation is used to reference the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.561 -|explicitMeasures|xs:boolean|(% style="width:598px" %)The explicitMeasures indicates whether explicit [[measures>>doc:sdmx:Glossary.Measure.WebHome]]are used in the cross sectional format. This is only applicable for the[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]as the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)or the flat structure.562 -|serviceURL|xs:anyURI|(% style="width:598px" %)The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the URL of an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]repository, as they both implement that same web service interface.563 -|structureURL|xs:anyURI|(% style="width:598px" %)The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the URL of a[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]structure message (in the same(% style="color:#e74c3c" %)version(%%)as the source document) in which the externally referenced object is contained. Note that this may be a URL of an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]RESTful web service which will return the referenced object.557 +|structureID|xs:ID|(% style="width:598px" %)The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message. 558 +|schemaURL|xs:anyURI|(% style="width:598px" %)The schemaURL attribute provides a location from which the structure specific schema can be located. 559 +|namespace|xs:anyURI|(% style="width:598px" %)The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message. 560 +|dimensionAtObservation|ObservationDimensionType|(% style="width:598px" %)The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format. 561 +|explicitMeasures|xs:boolean|(% style="width:598px" %)The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure. 562 +|serviceURL|xs:anyURI|(% style="width:598px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. 563 +|structureURL|xs:anyURI|(% style="width:598px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. 564 564 565 565 Element Documentation: 566 566 567 567 (% style="width:1012.29px" %) 568 568 |(% style="width:184px" %)**Name**|(% style="width:295px" %)**Type**|(% style="width:530px" %)**Documentation** 569 -|(% style="width:184px" %)ProvisionAgreement|(% style="width:295px" %)ProvisionAgreementReferenceType|(% style="width:530px" %)ProvisionAgreement references a [[provision agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]]which the data is reported against.570 -|(% style="width:184px" %)StructureUsage|(% style="width:295px" %)DataflowReferenceType|(% style="width:530px" %)StructureUsage references a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]which the data is reported against.571 -|(% style="width:184px" %)Structure|(% style="width:295px" %)DataStructureReferenceType|(% style="width:530px" %)Structure references the [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]which defines the structure of the data.569 +|(% style="width:184px" %)ProvisionAgreement|(% style="width:295px" %)ProvisionAgreementReferenceType|(% style="width:530px" %)ProvisionAgreement references a provision agreement which the data is reported against. 570 +|(% style="width:184px" %)StructureUsage|(% style="width:295px" %)DataflowReferenceType|(% style="width:530px" %)StructureUsage references a dataflow which the data is reported against. 571 +|(% style="width:184px" %)Structure|(% style="width:295px" %)DataStructureReferenceType|(% style="width:530px" %)Structure references the data structure definition which defines the structure of the data. 572 572 573 -**StructureSpecificDataStructureType:** StructureSpecificDataStructureType defines the structural information for a structured [[data set>>doc:sdmx:Glossary.Dataset.WebHome]].In addition to referencing the data structure or[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]which defines the structure of the data, the namespace for the data structure specific schema as well as which[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is used at the observation(% style="color:#e74c3c" %)level(%%)must be provided. It is also necessary to state whether the format uses explicit[[measures>>doc:sdmx:Glossary.Measure.WebHome]], although this is technically only applicable is the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)is the[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]or the flat data format is used.573 +**StructureSpecificDataStructureType:** StructureSpecificDataStructureType defines the structural information for a structured data set. In addition to referencing the data structure or dataflow which defines the structure of the data, the namespace for the data structure specific schema as well as which dimension is used at the observation level must be provided. It is also necessary to state whether the format uses explicit measures, although this is technically only applicable is the dimension at the observation level is the measure dimension or the flat data format is used. 574 574 575 575 Derivation: 576 576 ... ... @@ -584,25 +584,25 @@ 584 584 Content: 585 585 (ProvisionAgreement | StructureUsage | Structure) 586 586 587 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Documentation:587 +Attribute Documentation: 588 588 589 589 (% style="width:1010.29px" %) 590 590 |**Name**|**Type**|(% style="width:562px" %)**Documentation** 591 -|structureID|xs:ID|(% style="width:562px" %)The structureID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]is present in the message.592 -|schemaURL|xs:anyURI|(% style="width:562px" %)The schemaURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]provides a location from which the structure specific schema can be located.593 -|namespace|xs:anyURI|(% style="width:562px" %)The namespace [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.594 -|dimensionAtObservation|ObservationDimensionType|(% style="width:562px" %)The dimensionAtObservation is used to reference the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.595 -|explicitMeasures (default: false)|xs:boolean|(% style="width:562px" %)The explicitMeasures indicates whether explicit [[measures>>doc:sdmx:Glossary.Measure.WebHome]]are used in the cross sectional format. This is only applicable for the[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]as the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)or the flat structure.596 -|serviceURL|xs:anyURI|(% style="width:562px" %)The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the URL of an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]repository, as they both implement that same web service interface.597 -|structureURL|xs:anyURI|(% style="width:562px" %)The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the URL of a[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]structure message (in the same(% style="color:#e74c3c" %)version(%%)as the source document) in which the externally referenced object is contained. Note that this may be a URL of an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]RESTful web service which will return the referenced object.591 +|structureID|xs:ID|(% style="width:562px" %)The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message. 592 +|schemaURL|xs:anyURI|(% style="width:562px" %)The schemaURL attribute provides a location from which the structure specific schema can be located. 593 +|namespace|xs:anyURI|(% style="width:562px" %)The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message. 594 +|dimensionAtObservation|ObservationDimensionType|(% style="width:562px" %)The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format. 595 +|explicitMeasures (default: false)|xs:boolean|(% style="width:562px" %)The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure. 596 +|serviceURL|xs:anyURI|(% style="width:562px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. 597 +|structureURL|xs:anyURI|(% style="width:562px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. 598 598 599 599 Element Documentation: 600 600 601 601 (% style="width:1018.29px" %) 602 602 |(% style="width:202px" %)**Name**|(% style="width:284px" %)**Type**|(% style="width:529px" %)**Documentation** 603 -|(% style="width:202px" %)ProvisionAgreement|(% style="width:284px" %)ProvisionAgreementReferenceType|(% style="width:529px" %)ProvisionAgreement references a [[provision agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]]which the data is reported against.604 -|(% style="width:202px" %)StructureUsage|(% style="width:284px" %)DataflowReferenceType|(% style="width:529px" %)StructureUsage references a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]which the data is reported against.605 -|(% style="width:202px" %)Structure|(% style="width:284px" %)DataStructureReferenceType|(% style="width:529px" %)Structure references the [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]which defines the structure of the data.603 +|(% style="width:202px" %)ProvisionAgreement|(% style="width:284px" %)ProvisionAgreementReferenceType|(% style="width:529px" %)ProvisionAgreement references a provision agreement which the data is reported against. 604 +|(% style="width:202px" %)StructureUsage|(% style="width:284px" %)DataflowReferenceType|(% style="width:529px" %)StructureUsage references a dataflow which the data is reported against. 605 +|(% style="width:202px" %)Structure|(% style="width:284px" %)DataStructureReferenceType|(% style="width:529px" %)Structure references the data structure definition which defines the structure of the data. 606 606 607 607 //**MetadataStructureType:**// MetadataStructureType is an abstract base type the forms the basis of the structural information for any metadata message. A reference to the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] or a [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] must be provided. This can be used to determine the structure of the message. 608 608