Changes for page Part VI. Registry Namespace

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,6 +1,7 @@
1	1	{{box title="**Contents**"}}
2	2	{{toc/}}
3	3	{{/box}}
	4	+
4	4
5	5	= 1. Introduction =
6	6
...	...	@@ -9,7 +9,6 @@
9	9	As was done with the query, the registry message set now contains distinct messages for each operation. The messages will eventually allow the registry to function in more standard web service mannter.
10	10
11	11	= 2. Schema Documentation =
12		-
13	13	== 2.1 Registry Namespace ==
14	14
15	15	**http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/registry**
...	...	@@ -17,13 +17,11 @@
17	17	=== 2.1.1 Summary ===
18	18
19	19	Referenced Namespaces:
	20	+|**Namespace**|**Prefix**
	21	+|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
	22	+|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure|str
	23	+|http:~/~/www.w3.org/2001/XMLSchema|xs
20	20
21		-(% style="width:706.294px" %)
22		-|(% style="width:505px" %)**Namespace**|(% style="width:198px" %)**Prefix**
23		-|(% style="width:505px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:198px" %)com
24		-|(% style="width:505px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure|(% style="width:198px" %)str
25		-|(% style="width:505px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:198px" %)xs
26		-
27	27	Contents:
28	28	39 Complex Types
29	29	5 Simple Types
...	...	@@ -39,25 +39,21 @@
39	39	ProvisionAgreement, Datasource
40	40
41	41	Attribute Documentation:
	40	+|**Name**|**Type**|**Documentation**
	41	+|id|com:IDType|The id attribute holds a registry assigned identification for the registration. This must be provided in a response message (unless an error occurred while submitting a new registration), and should be included when updating or deleting a registration.
	42	+|validFrom|xs:dateTime|The validFrom attribute provides an inclusive start date for providing supplemental validity information about the registration, so that data visibility from the registry can be controlled by the registrant.
	43	+|validTo|xs:dateTime|The validFrom attribute provides an inclusive end date for providing supplemental validity information about the registration, so that data visibility from the registry can be controlled by the registrant.
	44	+|lastUpdated|xs:dateTime|The lastUpdated attribute provides a timestamp for the last time the data source was updated.
	45	+|indexTimeSeries (default: false)|xs:boolean|The indexTimeSeries, if true, indicates that the registry must index all time series for the registered data. The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.
	46	+|indexDataSet (default: false)|xs:boolean|The indexDataSet, if true, indicates that the registry must index the range of actual (present) values for each dimension of the data set or identifier component of the metadata set (as indicated in the set's structure definition). The default value is false.
	47	+|indexAttributes (default: false)|xs:boolean|The indexAttributes, if true, indicates that the registry must index the range of actual (present) values for each attribute of the data set or the presence of the metadata attributes of the metadata set (as indicated in the set's structure definition). The default value is false.
	48	+|indexReportingPeriod (default: false)|xs:boolean|The indexReportingPeriod, if true, indicates that the registry must index the time period ranges for which data is present for the data source. The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.
42	42
43		-(% style="width:927.294px" %)
44		-|(% style="width:165px" %)**Name**|(% style="width:202px" %)**Type**|(% style="width:558px" %)**Documentation**
45		-|(% style="width:165px" %)id|(% style="width:202px" %)com:IDType|(% style="width:558px" %)The id attribute holds a registry assigned identification for the registration. This must be provided in a response message (unless an error occurred while submitting a new registration), and should be included when updating or deleting a registration.
46		-|(% style="width:165px" %)validFrom|(% style="width:202px" %)xs:dateTime|(% style="width:558px" %)The validFrom attribute provides an inclusive start date for providing supplemental validity information about the registration, so that data visibility from the registry can be controlled by the registrant.
47		-|(% style="width:165px" %)validTo|(% style="width:202px" %)xs:dateTime|(% style="width:558px" %)The validFrom attribute provides an inclusive end date for providing supplemental validity information about the registration, so that data visibility from the registry can be controlled by the registrant.
48		-|(% style="width:165px" %)lastUpdated|(% style="width:202px" %)xs:dateTime|(% style="width:558px" %)The lastUpdated attribute provides a timestamp for the last time the data source was updated.
49		-|(% style="width:165px" %)indexTimeSeries (default: false)|(% style="width:202px" %)xs:boolean|(% style="width:558px" %)The indexTimeSeries, if true, indicates that the registry must index all time series for the registered data. The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.
50		-|(% style="width:165px" %)indexDataSet (default: false)|(% style="width:202px" %)xs:boolean|(% style="width:558px" %)The indexDataSet, if true, indicates that the registry must index the range of actual (present) values for each dimension of the data set or identifier component of the metadata set (as indicated in the set's structure definition). The default value is false.
51		-|(% style="width:165px" %)indexAttributes (default: false)|(% style="width:202px" %)xs:boolean|(% style="width:558px" %)The indexAttributes, if true, indicates that the registry must index the range of actual (present) values for each attribute of the data set or the presence of the metadata attributes of the metadata set (as indicated in the set's structure definition). The default value is false.
52		-|(% style="width:165px" %)indexReportingPeriod (default: false)|(% style="width:202px" %)xs:boolean|(% style="width:558px" %)The indexReportingPeriod, if true, indicates that the registry must index the time period ranges for which data is present for the data source. The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.
53		-
54	54	Element Documentation:
	51	+|**Name**|**Type**|**Documentation**
	52	+|ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement provides a reference to the provision agreement that the data is being registered against.
	53	+|Datasource|DataSourceType|Datasource identifies the data source(s) where the registered data can be retrieved.
55	55
56		-(% style="width:952.294px" %)
57		-|(% style="width:176px" %)**Name**|(% style="width:329px" %)**Type**|(% style="width:444px" %)**Documentation**
58		-|(% style="width:176px" %)ProvisionAgreement|(% style="width:329px" %)com: ProvisionAgreementReferenceType|(% style="width:444px" %)ProvisionAgreement provides a reference to the provision agreement that the data is being registered against.
59		-|(% style="width:176px" %)Datasource|(% style="width:329px" %)DataSourceType|(% style="width:444px" %)Datasource identifies the data source(s) where the registered data can be retrieved.
60		-
61	61	**DataSourceType: **DataSourceType specifies the properties of a data or metadata source. Either a simple data source, a queryable data source, or both must be specified.
62	62
63	63	Content:
...	...	@@ -64,16 +64,13 @@
64	64	(SimpleDataSource | QueryableDataSource)[1..2]
65	65
66	66	Element Documentation:
	61	+|**Name**|**Type**|**Documentation**
	62	+|SimpleDataSource|xs:anyURI|SimpleDatasource describes a data source that is an SDMX-ML data or metadata message. It requires only the URL of the data.
	63	+|QueryableDataSource|QueryableDataSourceT ype|QueryableDatasource describes a data source that must be able to accept an SDMX-ML Query Message, and respond appropriately.
67	67
68		-(% style="width:979.294px" %)
69		-|(% style="width:192px" %)**Name**|(% style="width:226px" %)**Type**|(% style="width:558px" %)**Documentation**
70		-|(% style="width:192px" %)SimpleDataSource|(% style="width:226px" %)xs:anyURI|(% style="width:558px" %)SimpleDatasource describes a data source that is an SDMX-ML data or metadata message. It requires only the URL of the data.
71		-|(% style="width:192px" %)QueryableDataSource|(% style="width:226px" %)QueryableDataSourceType|(% style="width:558px" %)QueryableDatasource describes a data source that must be able to accept an SDMX-ML Query Message, and respond appropriately.
72		-
73	73	**SimpleDataSourceType: **SimpleDataSourceType describes a simple data source. The URL of the data is contained in the content.
74	74
75	75	Derivation:
76		-
77	77	* xs:anySimpleType (restriction)
78	78	** xs:anyURI (extension)
79	79	*** SimpleDataSourceType
...	...	@@ -84,14 +84,12 @@
84	84	Content:
85	85	Attribute Documentation:
86	86
87		-(% style="width:1015.29px" %)
88		-|(% style="width:199px" %)**Name**|(% style="width:139px" %)**Type**|(% style="width:675px" %)**Documentation**
89		-|(% style="width:199px" %)TYPE (fixed: SIMPLE)|(% style="width:139px" %)xs:string|(% style="width:675px" %)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.
	78	+|**Name**|**Type**|**Documentation**
	79	+|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.
90	90
91	91	**QueryableDataSourceType: **QueryableDataSourceType describes a queryable data source, and add a fixed attribute for ensuring only one queryable source can be provided.
92	92
93	93	Derivation:
94		-
95	95	* com:QueryableDataSourceType (extension)
96	96	** QueryableDataSourceType
97	97
...	...	@@ -102,21 +102,17 @@
102	102	com:DataURL, com:WSDLURL?, com:WADLURL?
103	103
104	104	Attribute Documentation:
	94	+|**Name**|**Type**|**Documentation**
	95	+|isRESTDatasource|xs:boolean|The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
	96	+|isWebServiceDatasource|xs:boolean|The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
	97	+|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	105
106		-(% style="width:1027.29px" %)
107		-|(% style="width:227px" %)**Name**|(% style="width:223px" %)**Type**|(% style="width:574px" %)**Documentation**
108		-|(% style="width:227px" %)isRESTDatasource|(% style="width:223px" %)xs:boolean|(% style="width:574px" %)The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
109		-|(% style="width:227px" %)isWebServiceDatasource|(% style="width:223px" %)xs:boolean|(% style="width:574px" %)The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
110		-|(% style="width:227px" %)TYPE (fixed: QUERY)|(% style="width:223px" %)xs:string|(% style="width:574px" %)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.
111		-
112	112	Element Documentation:
	100	+|**Name**|**Type**|**Documentation**
	101	+|com:DataURL|xs:anyURI|DataURL contains the URL of the data source.
	102	+|com:WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
	103	+|com:WADLURL|xs:anyURI|WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source.
113	113
114		-(% style="width:1034.29px" %)
115		-|**Name**|**Type**|(% style="width:644px" %)**Documentation**
116		-|com:DataURL|xs:anyURI|(% style="width:644px" %)DataURL contains the URL of the data source.
117		-|com:WSDLURL|xs:anyURI|(% style="width:644px" %)WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
118		-|com:WADLURL|xs:anyURI|(% style="width:644px" %)WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source.
119		-
120	120	**IdentifiableQueryType: **IdentifiableQueryType describes the structure of a query for an identifiable object.
121	121
122	122	Attributes:
...	...	@@ -126,15 +126,12 @@
126	126	{Empty}
127	127
128	128	Attribute Documentation:
	114	+|**Name**|**Type**|**Documentation**
	115	+|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.
129	129
130		-(% style="width:973.294px" %)
131		-|**Name**|**Type**|(% style="width:593px" %)**Documentation**
132		-|id (default: %)|IDQueryType|(% style="width:593px" %)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.
133		-
134	134	**VersionableQueryType: **VersionableQueryType describes the structure of a query for a versionable object.
135	135
136	136	Derivation:
137		-
138	138	* IdentifiableQueryType (extension)
139	139	** VersionableQueryType
140	140
...	...	@@ -145,371 +145,371 @@
145	145	{Empty}
146	146
147	147	Attribute Documentation:
	130	+|**Name**|**Type**|**Documentation**
	131	+|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.
	132	+|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.
148	148
149		-(% style="width:999.294px" %)
150		-|(% style="width:161px" %)**Name**|(% style="width:132px" %)**Type**|(% style="width:704px" %)**Documentation**
151		-|(% style="width:161px" %)id (default: %)|(% style="width:132px" %)IDQueryType|(% style="width:704px" %)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.
152		-|(% style="width:161px" %)version (default: *)|(% style="width:132px" %)VersionQueryType|(% style="width:704px" %)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.
153		-
154	154	**MaintainableQueryType: **MaintainableQueryType describes the structure of a query for a maintainable object.
155	155
156	156	Derivation:
157	157
158		-* IdentifiableQueryType (extension)
159		-** VersionableQueryType (extension)
160		-*** MaintainableQueryType
	138	+IdentifiableQueryType (extension)
	139	+ [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] VersionableQueryType (extension)
	140	+ [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MaintainableQueryType
161	161
162	162	Attributes:
	143	+
163	163	id?, version?, agencyID?
164	164
165	165	Content:
	147	+
166	166	{Empty}
167	167
168	168	Attribute Documentation:
169	169
170		-(% style="width:1012.29px" %)
171		-|(% style="width:190px" %)**Name**|(% style="width:136px" %)**Type**|(% style="width:657px" %)**Documentation**
172		-|(% style="width:190px" %)id (default: %)|(% style="width:136px" %)IDQueryType|(% style="width:657px" %)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.
173		-|(% style="width:190px" %)version (default: *)|(% style="width:136px" %)VersionQueryType|(% style="width:657px" %)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.
174		-|(% style="width:190px" %)agencyID (default: %)|(% style="width:136px" %)NestedIDQueryType|(% style="width:657px" %)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.
	152	+|**Name**|**Type**|**Documentation**
	153	+|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.
	154	+|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.
	155	+|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.
175	175
176	176	**StatusMessageType: **StatusMessageType carries the text of error messages and/or warnings in response to queries or requests.
177	177
178	178	Attributes:
	160	+
179	179	status
180	180
181	181	Content:
	164	+
182	182	MessageText*
183	183
184	184	Attribute Documentation:
185	185
186		-(% style="width:995.294px" %)
187		-|**Name**|(% style="width:123px" %)**Type**|(% style="width:661px" %)**Documentation**
188		-|status|(% style="width:123px" %)StatusType|(% style="width:661px" %)The status attribute carries the status of the query or request.
	169	+|**Name**|**Type**|**Documentation**
	170	+|status|StatusType|The status attribute carries the status of the query or request.
189	189
190	190	Element Documentation:
191	191
192		-(% style="width:1006.29px" %)
193		-|**Name**|**Type**|(% style="width:543px" %)**Documentation**
194		-|MessageText|com: StatusMessageType|(% style="width:543px" %)MessageText contains the text of the error and/or warning message. It can occur multiple times to communicate message for multiple warnings or errors.
	174	+|**Name**|**Type**|**Documentation**
	175	+|MessageText|com: 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.
195	195
196	196	**SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of data/metadata set registrations.
197	197
198	198	Content:
	180	+
199	199	RegistrationRequest+
200	200
201	201	Element Documentation:
202	202
203		-(% style="width:1015.29px" %)
204		-|**Name**|**Type**|(% style="width:653px" %)**Documentation**
205		-|RegistrationRequest|RegistrationRequestType|(% style="width:653px" %)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.
	185	+|**Name**|**Type**|**Documentation**
	186	+|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.
206	206
207	207	**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.
208	208
209	209	Attributes:
	191	+
210	210	action
211	211
212	212	Content:
	195	+
213	213	Registration
214	214
215	215	Attribute Documentation:
216	216
217		-(% style="width:1012.29px" %)
218		-|**Name**|(% style="width:176px" %)**Type**|(% style="width:697px" %)**Documentation**
219		-|action|(% style="width:176px" %)com:ActionType|(% style="width:697px" %)The action attribute indicates whether this is an addition, a modification, or a deletion of a registration.
	200	+|**Name**|**Type**|**Documentation**
	201	+|action|com:ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a registration.
220	220
221	221	Element Documentation:
222	222
223		-(% style="width:1019.29px" %)
224		-|**Name**|(% style="width:163px" %)**Type**|(% style="width:637px" %)**Documentation**
225		-|Registration|(% style="width:163px" %)RegistrationType|(% style="width:637px" %)Registration contains the details of the data/metadata set registration to be added, updated, or deleted.
	205	+|**Name**|**Type**|**Documentation**
	206	+|Registration|RegistrationType|Registration contains the details of the data/metadata set registration to be added, updated, or deleted.
226	226
227	227	**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.
228	228
229	229	Content:
	211	+
230	230	RegistrationStatus+
231	231
232	232	Element Documentation:
233	233
234		-(% style="width:1012.29px" %)
235		-|**Name**|**Type**|(% style="width:545px" %)**Documentation**
236		-|RegistrationStatus|RegistrationStatusType|(% style="width:545px" %)RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.
	216	+|**Name**|**Type**|**Documentation**
	217	+|RegistrationStatus|RegistrationStatusTy pe|RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.
237	237
238	238	**RegistrationStatusType: **RegistrationStatusType describes the structure of a registration status.
239	239
240	240	Content:
	222	+
241	241	Registration, StatusMessage
242	242
243	243	Element Documentation:
244	244
245		-(% style="width:1005.29px" %)
246		-|**Name**|(% style="width:168px" %)**Type**|(% style="width:648px" %)**Documentation**
247		-|Registration|(% style="width:168px" %)RegistrationType|(% style="width:648px" %)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.
248		-|StatusMessage|(% style="width:168px" %)StatusMessageType|(% style="width:648px" %)StatusMessage provides that status for the registration request, and if necessary, any error or warning information.
	227	+|**Name**|**Type**|**Documentation**
	228	+|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.
	229	+|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration request, and if necessary, any error or warning information.
249	249
250	250	**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.
251	251
252	252	Attributes:
	234	+
253	253	returnConstraints?
254	254
255	255	Content:
	238	+
256	256	QueryType, (All | ProvisionAgreement | DataProvider | Dataflow | Metadataflow), ReferencePeriod?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*
257	257
258	258	Attribute Documentation:
259	259
260		-(% style="width:1016.29px" %)
261		-|(% style="width:252px" %)**Name**|(% style="width:148px" %)**Type**|(% style="width:614px" %)**Documentation**
262		-|(% style="width:252px" %)returnConstraints (default: false)|(% style="width:148px" %)xs:boolean|(% style="width:614px" %)The returnConstraints attribute determines whether information about the constraints on the data or metadata sets returned should also be sent the results.
	243	+|**Name**|**Type**|**Documentation**
	244	+|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.
263	263
264	264	Element Documentation:
265	265
266		-(% style="width:1021.29px" %)
267		-|**Name**|(% style="width:274px" %)**Type**|(% style="width:566px" %)**Documentation**
268		-|QueryType|(% style="width:274px" %)QueryTypeType|(% style="width:566px" %)QueryType defines the type of sets (data, metadata, or both) that are being queried for.
269		-|All|(% style="width:274px" %)com:EmptyType|(% style="width:566px" %)All indicates that all registrations meeting the other criteria of the query should be returned.
270		-|ProvisionAgreement|(% style="width:274px" %)com: ProvisionAgreementRe ferenceType|(% style="width:566px" %)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.
271		-|DataProvider|(% style="width:274px" %)com: DataProviderReferenceType|(% style="width:566px" %)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.
272		-|Dataflow|(% style="width:274px" %)com: DataflowReferenceType|(% style="width:566px" %)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.
273		-|Metadataflow|(% style="width:274px" %)com: MetadataflowReferenceType|(% style="width:566px" %)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
274		-|ReferencePeriod|(% style="width:274px" %)com: ReferencePeriodType|(% style="width:566px" %)ReferencePeriod provides an inclusive start and end date for the data or metadata being sought.
275		-|DataKeySet|(% style="width:274px" %)str:DataKeySetType|(% style="width:566px" %)DataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.
276		-|MetadataKeySet|(% style="width:274px" %)str: MetadataKeySetType|(% style="width:566px" %)MetadataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.
277		-|CubeRegion|(% style="width:274px" %)com:CubeRegionType|(% style="width:566px" %)CubeRegion is used to provide sets of include or excluded values for dimensions when querying for data.
278		-|MetadataTargetRegion|(% style="width:274px" %)com: MetadataTargetRegionType|(% style="width:566px" %)MetadataTargetRegion is used to provide sets of included or excluded values for identifier components when querying for metadata.
	248	+|**Name**|**Type**|**Documentation**
	249	+|QueryType|QueryTypeType|QueryType defines the type of sets (data, metadata, or both) that are being queried for.
	250	+|All|com:EmptyType|All indicates that all registrations meeting the other criteria of the query should be returned.
	251	+|ProvisionAgreement|com: 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.
	252	+|DataProvider|com: 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.
	253	+|Dataflow|com: 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.
	254	+|Metadataflow|com: 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
	255	+|ReferencePeriod|com: ReferencePeriodType|ReferencePeriod provides an inclusive start and end date for the data or metadata being sought.
	256	+|DataKeySet|str:DataKeySetType|DataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.
	257	+|MetadataKeySet|str: MetadataKeySetType|MetadataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.
	258	+|CubeRegion|com:CubeRegionType|CubeRegion is used to provide sets of include or excluded values for dimensions when querying for data.
	259	+|MetadataTargetRegion|com: MetadataTargetRegion Type|MetadataTargetRegion is used to provide sets of included or excluded values for identifier components when querying for metadata.
279	279
280	280	**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.
281	281
282	282	Content:
	264	+
283	283	StatusMessage, QueryResult*
284	284
285	285	Element Documentation:
286	286
287		-(% style="width:1027.29px" %)
288		-|**Name**|**Type**|(% style="width:607px" %)**Documentation**
289		-|StatusMessage|StatusMessageType|(% style="width:607px" %)StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.
290		-|QueryResult|QueryResultType|(% style="width:607px" %)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.
	269	+|**Name**|**Type**|**Documentation**
	270	+|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.
	271	+|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.
291	291
292	292	**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.
293	293
294	294	Attributes:
	276	+
295	295	timeSeriesMatch
296	296
297	297	Content:
	280	+
298	298	(DataResult | MetadataResult)
299	299
300	300	Attribute Documentation:
301	301
302		-(% style="width:1025.29px" %)
303		-|**Name**|**Type**|(% style="width:791px" %)**Documentation**
304		-|timeSeriesMatch|xs:boolean|(% style="width:791px" %)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.
	285	+|**Name**|**Type**|**Documentation**
	286	+|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.
305	305
306	306	Element Documentation:
307	307
308		-(% style="width:1024.29px" %)
309		-|(% style="width:221px" %)**Name**|(% style="width:174px" %)**Type**|(% style="width:626px" %)**Documentation**
310		-|(% style="width:221px" %)DataResult|(% style="width:174px" %)ResultType|(% style="width:626px" %)
311		-|(% style="width:221px" %)MetadataResult|(% style="width:174px" %)ResultType|(% style="width:626px" %)
	290	+|**Name**|**Type**|**Documentation**
	291	+|DataResult|ResultType|
	292	+|MetadataResult|ResultType|
312	312
313	313	**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.
314	314
315	315	Content:
	297	+
316	316	Registration, ContentConstraint*
317	317
318	318	Element Documentation:
319	319
320		-(% style="width:1026.29px" %)
321		-|**Name**|**Type**|(% style="width:593px" %)**Documentation**
322		-|Registration|RegistrationType|(% style="width:593px" %)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.
323		-|ContentConstraint|com: ContentConstraintReferenceType|(% style="width:593px" %)ContentConstraint provides a reference to a content 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.
	302	+|**Name**|**Type**|**Documentation**
	303	+|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.
	304	+|ContentConstraint|com: ContentConstraintRef erenceType|ContentConstraint provides a reference to a content 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.
324	324
325	325	**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.
326	326
327	327	Attributes:
	309	+
328	328	action?, externalDependencies?
329	329
330	330	Content:
	313	+
331	331	(StructureLocation | str:Structures), SubmittedStructure*
332	332
333	333	Attribute Documentation:
334	334
335		-(% style="width:1018.29px" %)
336		-|**Name**|**Type**|(% style="width:661px" %)**Documentation**
337		-|action (default: Append)|com:ActionType|(% style="width:661px" %)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.
338		-|externalDependencies (default: false)|xs:boolean|(% style="width:661px" %)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.
	318	+|**Name**|**Type**|**Documentation**
	319	+|action (default: Append)|com: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.
	320	+|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.
339	339
340	340	Element Documentation:
341	341
342		-(% style="width:1015.29px" %)
343		-|**Name**|**Type**|(% style="width:677px" %)**Documentation**
344		-|StructureLocation|xs:anyURI|(% style="width:677px" %)StructureLocation provides the location of a SDMX-ML Structure message, external to the repository that can be retrieved by the repository submission service.
345		-|str:Structures|str:StructuresType|(% style="width:677px" %)Structures allows for the inline definition of structural components for submission.
346		-|SubmittedStructure|SubmittedStructureType|(% style="width:677px" %)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.
	324	+|**Name**|**Type**|**Documentation**
	325	+|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.
	326	+|str:Structures|str:StructuresType|Structures allows for the inline definition of structural components for submission.
	327	+|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.
347	347
348	348	**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.
349	349
350	350	Attributes:
	332	+
351	351	action?, externalDependencies?
352	352
353	353	Content:
	336	+
354	354	MaintainableObject
355	355
356	356	Attribute Documentation:
357	357
358		-(% style="width:1024.29px" %)
359		-|**Name**|**Type**|(% style="width:714px" %)**Documentation**
360		-|action|com:ActionType|(% style="width:714px" %)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.
361		-|externalDependencies|xs:boolean|(% style="width:714px" %)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 key family 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.
	341	+|**Name**|**Type**|**Documentation**
	342	+|action|com: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.
	343	+|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 key family 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.
362	362
363	363	Element Documentation:
364	364
365		-(% style="width:1024.29px" %)
366		-|(% style="width:308px" %)**Name**|(% style="width:264px" %)**Type**|(% style="width:449px" %)**Documentation**
367		-|(% style="width:308px" %)MaintainableObject|(% style="width:264px" %)com: MaintainableReferenceType|(% style="width:449px" %)
	347	+|**Name**|**Type**|**Documentation**
	348	+|MaintainableObject|com: MaintainableReferenc eType|
368	368
369	369	**SubmitStructureResponseType: **SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.
370	370
371	371	Content:
	353	+
372	372	SubmissionResult+
373	373
374	374	Element Documentation:
375	375
376		-(% style="width:1024.29px" %)
377		-|(% style="width:290px" %)**Name**|(% style="width:279px" %)**Type**|(% style="width:452px" %)**Documentation**
378		-|(% style="width:290px" %)SubmissionResult|(% style="width:279px" %)SubmissionResultType|(% style="width:452px" %)SubmissionResult provides a status for each submitted structural object.
	358	+|**Name**|**Type**|**Documentation**
	359	+|SubmissionResult|SubmissionResultType|SubmissionResult provides a status for each submitted structural object.
379	379
380	380	**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.
381	381
382	382	Content:
	364	+
383	383	SubmittedStructure, StatusMessage
384	384
385	385	Element Documentation:
386	386
387		-(% style="width:1043.29px" %)
388		-|(% style="width:208px" %)**Name**|(% style="width:231px" %)**Type**|(% style="width:601px" %)**Documentation**
389		-|(% style="width:208px" %)SubmittedStructure|(% style="width:231px" %)SubmittedStructureType|(% style="width:601px" %)SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.
390		-|(% style="width:208px" %)StatusMessage|(% style="width:231px" %)StatusMessageType|(% style="width:601px" %)StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.
	369	+|**Name**|**Type**|**Documentation**
	370	+|SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.
	371	+|StatusMessage|StatusMessageType|StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.
391	391
392	392	**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.
393	393
394	394	Content:
	376	+
395	395	SubscriptionRequest+
396	396
397	397	Element Documentation:
398	398
399		-(% style="width:1043.29px" %)
400		-|(% style="width:189px" %)**Name**|(% style="width:241px" %)**Type**|(% style="width:610px" %)**Documentation**
401		-|(% style="width:189px" %)SubscriptionRequest|(% style="width:241px" %)SubscriptionRequestType|(% style="width:610px" %)
	381	+|**Name**|**Type**|**Documentation**
	382	+|SubscriptionRequest|SubscriptionRequestT ype|
402	402
403	403	**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.
404	404
405	405	Content:
	387	+
406	406	Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector
407	407
408	408	Element Documentation:
409	409
410		-(% style="width:996.294px" %)
411		-|**Name**|**Type**|(% style="width:570px" %)**Documentation**
412		-|Organisation|com: OrganisationReferenceType|(% style="width:570px" %)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.
413		-|RegistryURN|xs:anyURI|(% style="width:570px" %)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.
414		-|NotificationMailTo|NotificationURLType|(% style="width:570px" %)NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single subscription.
415		-|NotificationHTTP|NotificationURLType|(% style="width:570px" %)NotificationHTTP holds an http address to which notifications can be addressed as POSTs. Multiple http address may be notified for a single subscription event.
416		-|SubscriberAssignedID|com:IDType|(% style="width:570px" %)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.
417		-|ValidityPeriod|ValidityPeriodType|(% style="width:570px" %)Validity period sets a start and end date for the subscription.
418		-|EventSelector|EventSelectorType|(% style="width:570px" %)EventSelector indicates an event or events for the subscription.
	392	+|**Name**|**Type**|**Documentation**
	393	+|Organisation|com: 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.
	394	+|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.
	395	+|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single subscription.
	396	+|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.
	397	+|SubscriberAssignedID|com: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.
	398	+|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the subscription.
	399	+|EventSelector|EventSelectorType|EventSelector indicates an event or events for the subscription.
419	419
420	420	**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.
421	421
422	422	Attributes:
	404	+
423	423	action
424	424
425	425	Content:
	408	+
426	426	Subscription
427	427
428	428	Attribute Documentation:
429	429
430		-(% style="width:1007.29px" %)
431		-|**Name**|(% style="width:153px" %)**Type**|(% style="width:715px" %)**Documentation**
432		-|action|(% style="width:153px" %)com:ActionType|(% style="width:715px" %)The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.
	413	+|**Name**|**Type**|**Documentation**
	414	+|action|com:ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.
433	433
434	434	Element Documentation:
435	435
436		-(% style="width:1002.29px" %)
437		-|(% style="width:161px" %)**Name**|(% style="width:166px" %)**Type**|(% style="width:672px" %)**Documentation**
438		-|(% style="width:161px" %)Subscription|(% style="width:166px" %)SubscriptionType|(% style="width:672px" %)Subscription contains the details of the subscription to be added, updated, or deleted.
	418	+|**Name**|**Type**|**Documentation**
	419	+|Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.
439	439
440	440	**SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request.
441	441
442	442	Content:
	424	+
443	443	SubscriptionStatus+
444	444
445	445	Element Documentation:
446	446
447		-(% style="width:1001.29px" %)
448		-|**Name**|**Type**|(% style="width:662px" %)**Documentation**
449		-|SubscriptionStatus|SubscriptionStatusType|(% style="width:662px" %)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.
	429	+|**Name**|**Type**|**Documentation**
	430	+|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.
450	450
451	451	**SubscriptionStatusType: **SubscriptionStatusType describes the structure a status for a single subscription request.
452	452
453	453	Content:
	435	+
454	454	SubscriptionURN?, SubscriberAssignedID?, StatusMessage
455	455
456	456	Element Documentation:
457	457
458		-(% style="width:1007.29px" %)
459		-|(% style="width:191px" %)**Name**|(% style="width:168px" %)**Type**|(% style="width:645px" %)**Documentation**
460		-|(% style="width:191px" %)SubscriptionURN|(% style="width:168px" %)xs:anyURI|(% style="width:645px" %)SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.
461		-|(% style="width:191px" %)SubscriberAssignedID|(% style="width:168px" %)com:IDType|(% style="width:645px" %)SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.
462		-|(% style="width:191px" %)StatusMessage|(% style="width:168px" %)StatusMessageType|(% style="width:645px" %)StatusMessage provides that status for the subscription request, and if necessary, any error or warning information.
	440	+|**Name**|**Type**|**Documentation**
	441	+|SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.
	442	+|SubscriberAssignedID|com:IDType|SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.
	443	+|StatusMessage|StatusMessageType|StatusMessage provides that status for the subscription request, and if necessary, any error or warning information.
463	463
464	464	**QuerySubscriptionRequestType: **QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.
465	465
466	466	Content:
	448	+
467	467	Organisation
468	468
469	469	Element Documentation:
470	470
471		-(% style="width:1008.29px" %)
472		-|**Name**|(% style="width:258px" %)**Type**|(% style="width:551px" %)**Documentation**
473		-|Organisation|(% style="width:258px" %)com: OrganisationReferenceType|(% style="width:551px" %)Organisation provides a reference to the data consumer for which the subscription details should be returned.
	453	+|**Name**|**Type**|**Documentation**
	454	+|Organisation|com: OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.
474	474
475	475	**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.
476	476
477	477	Content:
	459	+
478	478	StatusMessage, Subscription*
479	479
480	480	Element Documentation:
481	481
482		-(% style="width:1018.29px" %)
483		-|(% style="width:164px" %)**Name**|(% style="width:178px" %)**Type**|(% style="width:673px" %)**Documentation**
484		-|(% style="width:164px" %)StatusMessage|(% style="width:178px" %)StatusMessageType|(% style="width:673px" %)StatusMessage provides that status for the query subscription request, and if necessary, any error or warning information.
485		-|(% style="width:164px" %)Subscription|(% style="width:178px" %)SubscriptionType|(% style="width:673px" %)Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.
	464	+|**Name**|**Type**|**Documentation**
	465	+|StatusMessage|StatusMessageType|StatusMessage provides that status for the query subscription request, and if necessary, any error or warning information.
	466	+|Subscription|SubscriptionType|Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.
486	486
487	487	**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.
488	488
489	489	Content:
	471	+
490	490	EventTime, (ObjectURN | RegistrationID), SubscriptionURN, EventAction, (StructuralEvent | RegistrationEvent)?
491	491
492	492	Element Documentation:
493	493
494		-(% style="width:1003.29px" %)
495		-|**Name**|(% style="width:179px" %)**Type**|(% style="width:632px" %)**Documentation**
496		-|EventTime|(% style="width:179px" %)xs:dateTime|(% style="width:632px" %)EventTime specifies the time of the triggering event.
497		-|ObjectURN|(% style="width:179px" %)xs:anyURI|(% style="width:632px" %)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.
498		-|RegistrationID|(% style="width:179px" %)com:IDType|(% style="width:632px" %)RegistrationID provides the id of the registration that underwent an event.
499		-|SubscriptionURN|(% style="width:179px" %)xs:anyURI|(% style="width:632px" %)SubscriptionURN provides the registry/repository URN of the subscription that is the cause of this notification being sent.
500		-|EventAction|(% style="width:179px" %)com:ActionType|(% style="width:632px" %)EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.
501		-|StructuralEvent|(% style="width:179px" %)StructuralEventType|(% style="width:632px" %)StructuralEvent is used to provide the details of the structural object that has changed.
502		-|RegistrationEvent|(% style="width:179px" %)RegistrationEventType|(% style="width:632px" %)RegistrationEvent is used to provide the details or the registration object that has changed.
	476	+|**Name**|**Type**|**Documentation**
	477	+|EventTime|xs:dateTime|EventTime specifies the time of the triggering event.
	478	+|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.
	479	+|RegistrationID|com:IDType|RegistrationID provides the id of the registration that underwent an event.
	480	+|SubscriptionURN|xs:anyURI|SubscriptionURN provides the registry/repository URN of the subscription that is the cause of this notification being sent.
	481	+|EventAction|com:ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.
	482	+|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed.
	483	+|RegistrationEvent|RegistrationEventTyp e|RegistrationEvent is used to provide the details or the registration object that has changed.
503	503
504	504	**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.
505	505
506	506	Derivation:
507	507
508		-* xs:anySimpleType (restriction)
509		-** xs:anyURI (extension)
510		-*** NotificationURLType
	489	+xs:anySimpleType (restriction)
	490	+ [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] xs:anyURI (extension)
	491	+ [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] NotificationURLType
511	511
512	512	Attributes:
	494	+
513	513	isSOAP?
514	514
515	515	Content:
...	...	@@ -516,208 +516,212 @@
516	516
517	517	Attribute Documentation:
518	518
519		-(% style="width:998.294px" %)
520		-|(% style="width:208px" %)**Name**|(% style="width:107px" %)**Type**|(% style="width:680px" %)**Documentation**
521		-|(% style="width:208px" %)isSOAP (default: false)|(% style="width:107px" %)xs:boolean|(% style="width:680px" %)The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.
	501	+|**Name**|**Type**|**Documentation**
	502	+|isSOAP (default: false)|xs:boolean|The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.
522	522
523	523	**ValidityPeriodType: **ValidityPeriodType specifies inclusive start and end-dates for the subscription period.
524	524
525	525	Content:
	507	+
526	526	StartDate, EndDate
527	527
528	528	Element Documentation:
529	529
530		-(% style="width:1000.29px" %)
531		-|(% style="width:152px" %)**Name**|(% style="width:166px" %)**Type**|(% style="width:679px" %)**Documentation**
532		-|(% style="width:152px" %)StartDate|(% style="width:166px" %)xs:date|(% style="width:679px" %)StartDate is an inclusive start date for the subscription.
533		-|(% style="width:152px" %)EndDate|(% style="width:166px" %)xs:date|(% style="width:679px" %)EndDate is an inclusive end date for the subscription.
	512	+|**Name**|**Type**|**Documentation**
	513	+|StartDate|xs:date|StartDate is an inclusive start date for the subscription.
	514	+|EndDate|xs:date|EndDate is an inclusive end date for the subscription.
534	534
535	535	**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.
536	536
537	537	Content:
	519	+
538	538	(StructuralRepositoryEvents | DataRegistrationEvents | MetadataRegistrationEvents)[1..3]
539	539
540	540	Element Documentation:
541	541
542		-(% style="width:1004.29px" %)
543		-|(% style="width:260px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:459px" %)**Documentation**
544		-|(% style="width:260px" %)StructuralRepository Events|(% style="width:281px" %)StructuralRepositoryEventsType|(% style="width:459px" %)StructuralRepositoryEvents details structural events for the subscription.
545		-|(% style="width:260px" %)DataRegistrationEven ts|(% style="width:281px" %)DataRegistrationEventsType|(% style="width:459px" %)DataRegistrationEvents details the data registration events for the subscription.
546		-|(% style="width:260px" %)MetadataRegistration Events|(% style="width:281px" %)MetadataRegistrationEventsType|(% style="width:459px" %)MetadataRegistrationEvents details the metadata registration events for the subscription.
	524	+|**Name**|**Type**|**Documentation**
	525	+|StructuralRepository Events|StructuralRepository EventsType|StructuralRepositoryEvents details structural events for the subscription.
	526	+|DataRegistrationEven ts|DataRegistrationEven tsType|DataRegistrationEvents details the data registration events for the subscription.
	527	+|MetadataRegistration Events|MetadataRegistration EventsType|MetadataRegistrationEvents details the metadata registration events for the subscription.
547	547
548	548	**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.
549	549
550	550	Attributes:
	532	+
551	551	TYPE?
552	552
553	553	Content:
	536	+
554	554	AgencyID+, (AllEvents | (AgencyScheme | DataConsmerScheme | DataProviderScheme | OrganisationUnitScheme | Dataflow | Metadataflow | CategoryScheme | Categorisation | Codelist | HierarchicalCodelist | ConceptScheme | MetadataStructureDefinition | KeyFamily | StructureSet | ReportingTaxonomy | Process | AttachmentConstraint | ContentConstraint | ProvisionAgreement | TransformationScheme | NameAliasScheme | NamePersonalisationScheme | RulesetScheme | UserDefinedOperatorScheme)+)
555	555
556	556	Attribute Documentation:
557	557
558		-(% style="width:1013.29px" %)
559		-|(% style="width:244px" %)**Name**|(% style="width:218px" %)**Type**|(% style="width:547px" %)**Documentation**
560		-|(% style="width:244px" %)TYPE (fixed: STRUCTURE)|(% style="width:218px" %)xs:string|(% style="width:547px" %)TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.
	541	+|**Name**|**Type**|**Documentation**
	542	+|TYPE (fixed: STRUCTURE)|xs:string|TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.
561	561
562	562	Element Documentation:
563	563
564		-(% style="width:1007.29px" %)
565		-|**Name**|**Type**|(% style="width:580px" %)**Documentation**
566		-|AgencyID|NestedIDQueryType|(% style="width:580px" %)AgencyID specifies a maintenance agency for the object or objects indicated in the other fields. This can be either a specific ID, or a single wildcard character ("%"). A wild card character can be used to select all agencies, allowing a subscription to all events for particular object types. This can occur multiple times to list a of group of maintenance agencies, creating event subscriptions for all of the subsequent objects for each agency in the group. Note that if multiple agencies are supplied, then the wildcard character should not be used for any of them.
567		-|AllEvents|com:EmptyType|(% style="width:580px" %)AllEvents creates a subscription to structural events for all structural objects maintained by the agencies referenced.
568		-|AgencyScheme|VersionableObjectEventType|(% style="width:580px" %)AgencyScheme is used to subscribe to changes of agency schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
569		-|DataConsmerScheme|VersionableObjectEventType|(% style="width:580px" %)DataConsmerScheme is used to subscribe to changes of data consumer schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
570		-|DataProviderScheme|VersionableObjectEventType|(% style="width:580px" %)DataProviderScheme is used to subscribe to changes of data provider schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
571		-|OrganisationUnitSche me|VersionableObjectEventType|(% style="width:580px" %)OrganisationUnitScheme is used to subscribe to changes of organisation unit schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
572		-|Dataflow|VersionableObjectEventType|(% style="width:580px" %)Dataflow is used to subscribe to changes of data flows. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
573		-|Metadataflow|VersionableObjectEventType|(% style="width:580px" %)Metadataflow is used to subscribe to changes of metadata flows. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
574		-|CategoryScheme|VersionableObjectEventType|(% style="width:580px" %)CategoryScheme is used to subscribe to changes of category schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
575		-|Categorisation|IdentifiableObjectEv entType|(% style="width:580px" %)Categorisation is used to subscribe to changes of categorizations. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id field can be selected.
576		-|Codelist|VersionableObjectEventType|(% style="width:580px" %)Codelist is used to subscribe to changes of code lists. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
577		-|HierarchicalCodelist|VersionableObjectEventType|(% style="width:580px" %)HierarchicalCodelist is used to subscribe to changes of hierarchical code lists. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
578		-|ConceptScheme|VersionableObjectEventType|(% style="width:580px" %)ConceptScheme is used to subscribe to changes of concept schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
579		-|MetadataStructureDef inition|VersionableObjectEventType|(% style="width:580px" %)MetadataStructureDefinition is used to subscribe to changes of metadata structure definitions. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
580		-|KeyFamily|VersionableObjectEventType|(% style="width:580px" %)KeyFamily is used to subscribe to changes of key families. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
581		-|StructureSet|VersionableObjectEventType|(% style="width:580px" %)StructureSet is used to subscribe to changes of structure sets. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
582		-|ReportingTaxonomy|VersionableObjectEventType|(% style="width:580px" %)ReportingTaxonomy is used to subscribe to changes of reporting taxonomies. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
583		-|Process|VersionableObjectEventType|(% style="width:580px" %)Process is used to subscribe to changes of processes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
584		-|AttachmentConstraint|VersionableObjectEventType|(% style="width:580px" %)AttachmentConstraint is used to subscribe to changes of attachment constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
585		-|ContentConstraint|VersionableObjectEventType|(% style="width:580px" %)ContentConstraint is used to subscribe to changes of content constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
586		-|ProvisionAgreement|VersionableObjectEventType|(% style="width:580px" %)ProvisionAgreement is used to subscribe to changes of a provision agreement. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
587		-|TransformationScheme|VersionableObjectEventType|(% style="width:580px" %)TransformationScheme is used to subscribe to changes of a transformation scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
588		-|NameAliasScheme|VersionableObjectEventType|(% style="width:580px" %)NameAliasScheme is used to subscribe to changes of a name alias scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
589		-|NamePersonalisationS cheme|VersionableObjectEventType|(% style="width:580px" %)NamePersonalisationScheme is used to subscribe to changes of a name peronsalisation scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
590		-|RulesetScheme|VersionableObjectEventType|(% style="width:580px" %)RulesetScheme is used to subscribe to changes of a ruleset scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
591		-|UserDefinedOperatorS cheme|VersionableObjectEventType|(% style="width:580px" %)UserDefinedOperatorScheme is used to subscribe to changes of a user defined operator scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	546	+|**Name**|**Type**|**Documentation**
	547	+|AgencyID|NestedIDQueryType|AgencyID specifies a maintenance agency for the object or objects indicated in the other fields. This can be either a specific ID, or a single wildcard character ("%"). A wild card character can be used to select all agencies, allowing a subscription to all events for particular object types. This can occur multiple times to list a of group of maintenance agencies, creating event subscriptions for all of the subsequent objects for each agency in the group. Note that if multiple agencies are supplied, then the wildcard character should not be used for any of them.
	548	+|AllEvents|com:EmptyType|AllEvents creates a subscription to structural events for all structural objects maintained by the agencies referenced.
	549	+|AgencyScheme|VersionableObjectEve ntType|AgencyScheme is used to subscribe to changes of agency schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	550	+|DataConsmerScheme|VersionableObjectEve ntType|DataConsmerScheme is used to subscribe to changes of data consumer schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	551	+|DataProviderScheme|VersionableObjectEve ntType|DataProviderScheme is used to subscribe to changes of data provider schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	552	+|OrganisationUnitSche me|VersionableObjectEve ntType|OrganisationUnitScheme is used to subscribe to changes of organisation unit schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	553	+|Dataflow|VersionableObjectEve ntType|Dataflow is used to subscribe to changes of data flows. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	554	+|Metadataflow|VersionableObjectEve ntType|Metadataflow is used to subscribe to changes of metadata flows. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	555	+|CategoryScheme|VersionableObjectEve ntType|CategoryScheme is used to subscribe to changes of category schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	556	+|Categorisation|IdentifiableObjectEv entType|Categorisation is used to subscribe to changes of categorizations. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id field can be selected.
	557	+|Codelist|VersionableObjectEve ntType|Codelist is used to subscribe to changes of code lists. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	558	+|HierarchicalCodelist|VersionableObjectEve ntType|HierarchicalCodelist is used to subscribe to changes of hierarchical code lists. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	559	+|ConceptScheme|VersionableObjectEve ntType|ConceptScheme is used to subscribe to changes of concept schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	560	+|MetadataStructureDef inition|VersionableObjectEve ntType|MetadataStructureDefinition is used to subscribe to changes of metadata structure definitions. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	561	+|KeyFamily|VersionableObjectEve ntType|KeyFamily is used to subscribe to changes of key families. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	562	+|StructureSet|VersionableObjectEve ntType|StructureSet is used to subscribe to changes of structure sets. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	563	+|ReportingTaxonomy|VersionableObjectEve ntType|ReportingTaxonomy is used to subscribe to changes of reporting taxonomies. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	564	+|Process|VersionableObjectEve ntType|Process is used to subscribe to changes of processes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	565	+|AttachmentConstraint|VersionableObjectEve ntType|AttachmentConstraint is used to subscribe to changes of attachment constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	566	+|ContentConstraint|VersionableObjectEve ntType|ContentConstraint is used to subscribe to changes of content constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	567	+|ProvisionAgreement|VersionableObjectEve ntType|ProvisionAgreement is used to subscribe to changes of a provision agreement. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	568	+|TransformationScheme|VersionableObjectEve ntType|TransformationScheme is used to subscribe to changes of a transformation scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	569	+|NameAliasScheme|VersionableObjectEve ntType|NameAliasScheme is used to subscribe to changes of a name alias scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	570	+|NamePersonalisationS cheme|VersionableObjectEve ntType|NamePersonalisationScheme is used to subscribe to changes of a name peronsalisation scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	571	+|RulesetScheme|VersionableObjectEve ntType|RulesetScheme is used to subscribe to changes of a ruleset scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
	572	+|UserDefinedOperatorS cheme|VersionableObjectEve ntType|UserDefinedOperatorScheme is used to subscribe to changes of a user defined operator scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
592	592
593	593	**IdentifiableObjectEventType: **IdentifiableObjectEventType describes the structure of a reference to an identifiable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.
594	594
595	595	Content:
	577	+
596	596	(All | URN | ID)
597	597
598	598	Element Documentation:
599	599
600		-(% style="width:1004.29px" %)
601		-|**Name**|**Type**|(% style="width:774px" %)**Documentation**
602		-|All|com:EmptyType|(% style="width:774px" %)All subscribes to the events all instances of the containing object meeting the other criteria specified.
603		-|URN|xs:anyURI|(% style="width:774px" %)URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.
604		-|ID|IDQueryType|(% style="width:774px" %)ID subscribes to the events of the specific instance of the object type where the value provided here matches the id of the object. The default value is the wildcard character("%").
	582	+|**Name**|**Type**|**Documentation**
	583	+|All|com:EmptyType|All subscribes to the events all instances of the containing object meeting the other criteria specified.
	584	+|URN|xs:anyURI|URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.
	585	+|ID|IDQueryType|ID subscribes to the events of the specific instance of the object type where the value provided here matches the id of the object. The default value is the wildcard character("%").
605	605
606	606	**VersionableObjectEventType: **VersionableObjectEventType describes the structure of a reference to a versionable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.
607	607
608	608	Content:
	590	+
609	609	(All | URN | (ID, Version))
610	610
611	611	Element Documentation:
612	612
613		-(% style="width:997.294px" %)
614		-|**Name**|**Type**|(% style="width:775px" %)**Documentation**
615		-|All|com:EmptyType|(% style="width:775px" %)All subscribes to the events all instances of the containing object meeting the other criteria specified.
616		-|URN|xs:anyURI|(% style="width:775px" %)URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.
617		-|ID|IDQueryType|(% style="width:775px" %)ID subscribes to the events of the specific instance of the object type where the value provided here matches the id of the object and the value provided in the version field matches the version of the object. The default value is the wildcard character("%").
618		-|Version|VersionQueryType|(% style="width:775px" %)Version subscribes to the events of the specific instance of the object type where the value provided in the id field matches the id of the object and the value here matches the version of the object. The default value is the wildcard character("%"). Note that in addition to being wild-carded, this can also be bound to the latest version of the object with the late-bound character("*").
	595	+|**Name**|**Type**|**Documentation**
	596	+|All|com:EmptyType|All subscribes to the events all instances of the containing object meeting the other criteria specified.
	597	+|URN|xs:anyURI|URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.
	598	+|ID|IDQueryType|ID subscribes to the events of the specific instance of the object type where the value provided here matches the id of the object and the value provided in the version field matches the version of the object. The default value is the wildcard character("%").
	599	+|Version|VersionQueryType|Version subscribes to the events of the specific instance of the object type where the value provided in the id field matches the id of the object and the value here matches the version of the object. The default value is the wildcard character("%"). Note that in addition to being wild-carded, this can also be bound to the latest version of the object with the late-bound character("*").
619	619
620	620	**DataRegistrationEventsType: **DataRegistrationEventsType details the data registration events for the subscription. It is possible to subscribe to all data registration events in the repository, or specific events for; single registrations, provision agreements, data providers, data flows, key families, and categories that categorize data flows or key families.
621	621
622	622	Attributes:
	604	+
623	623	TYPE?
624	624
625	625	Content:
	608	+
626	626	(AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | DataflowReference | KeyFamilyReference | Category)+)
627	627
628	628	Attribute Documentation:
629	629
630		-(% style="width:1012.29px" %)
631		-|**Name**|**Type**|(% style="width:621px" %)**Documentation**
632		-|TYPE (fixed: DATA)|xs:string|(% style="width:621px" %)TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.
	613	+|**Name**|**Type**|**Documentation**
	614	+|TYPE (fixed: DATA)|xs:string|TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.
633	633
634	634	Element Documentation:
635	635
636		-(% style="width:1019.29px" %)
637		-|**Name**|**Type**|(% style="width:521px" %)**Documentation**
638		-|AllEvents|com:EmptyType|(% style="width:521px" %)AllEvents subscribes to all data registration events in the repository.
639		-|RegistrationID|com:IDType|(% style="width:521px" %)RegistrationID subscribes to all the data registration events for the unique registration referenced.
640		-|ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:521px" %)ProvisionAgreementReference subscribes to all data registration events for the explicitly referenced provision agreement.
641		-|DataProvider|com: DataProviderReferenceType|(% style="width:521px" %)DataProviderReference subscribes to all data registration events for the explicitly referenced data provider.
642		-|DataflowReference|MaintainableEventType|(% style="width:521px" %)DataflowReference subscribes to all data registration events for the data flows referenced by this object. This may reference one or more data flows, as the specific references fields allow for a wild-carded value.
643		-|KeyFamilyReference|MaintainableEventType|(% style="width:521px" %)KeyFamilyReference subscribes to all data registration events for the key families referenced by this object. This may reference one or more key families, as the specific references fields allow for a wild-carded value.
644		-|Category|com: CategoryReferenceType|(% style="width:521px" %)Category subscribes to all data registration events for any data flows or key families that are categorized by the referenced category.
	618	+|**Name**|**Type**|**Documentation**
	619	+|AllEvents|com:EmptyType|AllEvents subscribes to all data registration events in the repository.
	620	+|RegistrationID|com:IDType|RegistrationID subscribes to all the data registration events for the unique registration referenced.
	621	+|ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreementReference subscribes to all data registration events for the explicitly referenced provision agreement.
	622	+|DataProvider|com: DataProviderReferenc eType|DataProviderReference subscribes to all data registration events for the explicitly referenced data provider.
	623	+|DataflowReference|MaintainableEventTyp e|DataflowReference subscribes to all data registration events for the data flows referenced by this object. This may reference one or more data flows, as the specific references fields allow for a wild-carded value.
	624	+|KeyFamilyReference|MaintainableEventTyp e|KeyFamilyReference subscribes to all data registration events for the key families referenced by this object. This may reference one or more key families, as the specific references fields allow for a wild-carded value.
	625	+|Category|com: CategoryReferenceTyp e|Category subscribes to all data registration events for any data flows or key families that are categorized by the referenced category.
645	645
646	646	**MetadataRegistrationEventsType: **MetadataRegistrationEventsType details the metadata registration events for the subscription. It is possible to subscribe to all metadata registration events in the repository, or specific events for; single registrations, provision agreements, data providers, metadata flows, metadata structure definitions, and categories that categorize metadata flows or metadata structure definitions.
647	647
648	648	Attributes:
	630	+
649	649	TYPE?
650	650
651	651	Content:
	634	+
652	652	(AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | MetadataflowReference | MetadataStructureDefinitionReference | Category)+)
653	653
654	654	Attribute Documentation:
655	655
656		-(% style="width:1049.29px" %)
657		-|(% style="width:231px" %)**Name**|(% style="width:213px" %)**Type**|(% style="width:602px" %)**Documentation**
658		-|(% style="width:231px" %)TYPE (fixed: METADATA)|(% style="width:213px" %)xs:string|(% style="width:602px" %)TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.
	639	+|**Name**|**Type**|**Documentation**
	640	+|TYPE (fixed: METADATA)|xs:string|TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.
659	659
660	660	Element Documentation:
661	661
662		-(% style="width:1049.29px" %)
663		-|**Name**|**Type**|(% style="width:494px" %)**Documentation**
664		-|AllEvents|com:EmptyType|(% style="width:494px" %)AllEvents subscribes to all metadata registration events in the repository.
665		-|RegistrationID|com:IDType|(% style="width:494px" %)RegistrationID subscribes to all the metadata registration events for the unique registration referenced.
666		-|ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:494px" %)ProvisionAgreementReference subscribes to all metadata registration events for the explicitly referenced provision agreement.
667		-|DataProvider|com: DataProviderReferenceType|(% style="width:494px" %)DataProvider subscribes to all metadata registration events for the explicitly referenced data provider.
668		-|MetadataflowReference|MaintainableEventType|(% style="width:494px" %)MetadataflowReference subscribes to all metadata registration events for the metadata flows referenced by this object. This may reference one or more metadata flows, as the specific references fields allow for a wild-carded value.
669		-|MetadataStructureDefinitionReference|MaintainableEventType|(% style="width:494px" %)MetadataStructureDefinitionReference subscribes to all metadata registration events for the metadata structure definitions referenced by this object. This may reference one or more metadata structure definitions, as the specific references fields allow for a wild-carded value.
670		-|Category|com: CategoryReferenceType|(% style="width:494px" %)Category subscribes to all metadata registration events for any metadata flows or metadata structure definitions that are categorized by the referenced category.
	644	+|**Name**|**Type**|**Documentation**
	645	+|AllEvents|com:EmptyType|AllEvents subscribes to all metadata registration events in the repository.
	646	+|RegistrationID|com:IDType|RegistrationID subscribes to all the metadata registration events for the unique registration referenced.
	647	+|ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreementReference subscribes to all metadata registration events for the explicitly referenced provision agreement.
	648	+|DataProvider|com: DataProviderReferenc eType|DataProvider subscribes to all metadata registration events for the explicitly referenced data provider.
	649	+|MetadataflowReferenc e|MaintainableEventTyp e|MetadataflowReference subscribes to all metadata registration events for the metadata flows referenced by this object. This may reference one or more metadata flows, as the specific references fields allow for a wild-carded value.
	650	+|MetadataStructureDef initionReference|MaintainableEventTyp e|MetadataStructureDefinitionReference subscribes to all metadata registration events for the metadata structure definitions referenced by this object. This may reference one or more metadata structure definitions, as the specific references fields allow for a wild-carded value.
	651	+|Category|com: CategoryReferenceTyp e|Category subscribes to all metadata registration events for any metadata flows or metadata structure definitions that are categorized by the referenced category.
671	671
672	672	**MaintainableEventType: **MaintainableEventType provides a reference to a maintainable object's event with either the URN of the specific object, or a set of potentially wild-carded reference fields.
673	673
674	674	Content:
	656	+
675	675	(URN | Ref)
676	676
677	677	Element Documentation:
678	678
679		-(% style="width:1059.29px" %)
680		-|**Name**|(% style="width:207px" %)**Type**|(% style="width:727px" %)**Documentation**
681		-|URN|(% style="width:207px" %)xs:anyURI|(% style="width:727px" %)URN provides an explicit reference to a single object.
682		-|Ref|(% style="width:207px" %)MaintainableQueryType|(% style="width:727px" %)Ref provides a reference to potentially many object through the use of possible wild-carded reference fields.
	661	+|**Name**|**Type**|**Documentation**
	662	+|URN|xs:anyURI|URN provides an explicit reference to a single object.
	663	+|Ref|MaintainableQueryTyp e|Ref provides a reference to potentially many object through the use of possible wild-carded reference fields.
683	683
684	684	**StructuralEventType: **StructuralEventType provides the details of a structure event, specifically the object that changed.
685	685
686	686	Content:
	668	+
687	687	str:Structures
688	688
689	689	Element Documentation:
690	690
691		-(% style="width:1070.29px" %)
692		-|**Name**|**Type**|(% style="width:732px" %)**Documentation**
693		-|str:Structures|str:StructuresType|(% style="width:732px" %)Structures contains the details of the structural object that has triggered the event. Although this container allows for multiple structural object, it should only contain the one changed object.
	673	+|**Name**|**Type**|**Documentation**
	674	+|str:Structures|str:StructuresType|Structures contains the details of the structural object that has triggered the event. Although this container allows for multiple structural object, it should only contain the one changed object.
694	694
695	695	**RegistrationEventType: **This provides the details of a data or metadata registration event for the purposes of notification.
696	696
697	697	Content:
	679	+
698	698	Registration
699	699
700	700	Element Documentation:
701	701
702		-(% style="width:1003.29px" %)
703		-|**Name**|(% style="width:172px" %)**Type**|(% style="width:563px" %)**Documentation**
704		-|Registration|(% style="width:172px" %)RegistrationType|(% style="width:563px" %)Registration provides the changed details of the data or metadata registration.
	684	+|**Name**|**Type**|**Documentation**
	685	+|Registration|RegistrationType|Registration provides the changed details of the data or metadata registration.
705	705
706		-=== 2.1.3 Simple Types ===
	687	+1.
	688	+11.
	689	+111. Simple Types
707	707
708	708	**IDQueryType: **IDQueryType is a simple type that allows for an identifier to be substituted with a wild card character ("%").
709	709
710	710	Union of:
	694	+
711	711	com:IDType, com:WildCardValueType.
712	712
713	713	**NestedIDQueryType: **NestedIDQueryType is a simple type that allows for a nested identifier to be substituted with a wild card character ("%").
714	714
715	715	Union of:
	700	+
716	716	com:NestedIDType, com:WildCardValueType.
717	717
718	718	**VersionQueryType: **VersionQueryType is a simple type that allows for a version number to be substituted with a wild card character ("%") or a late bound character ("*").
719	719
720	720	Union of:
	706	+
721	721	com:VersionType, com:LateBoundVersionType, com:WildCardValueType.
722	722
723	723	**StatusType: **StatusType provides an enumeration of values that detail the status of queries or requests.
...	...	@@ -726,11 +726,10 @@
726	726
727	727	Enumerations:
728	728
729		-(% style="width:1004.29px" %)
730		-|(% style="width:183px" %)**Value**|(% style="width:818px" %)**Documentation**
731		-|(% style="width:183px" %)Success|(% style="width:818px" %)Query or request successful.
732		-|(% style="width:183px" %)Warning|(% style="width:818px" %)Query or request successful, but with warnings.
733		-|(% style="width:183px" %)Failure|(% style="width:818px" %)Query or request not successful.
	715	+|**Value**|**Documentation**
	716	+|Success|Query or request successful.
	717	+|Warning|Query or request successful, but with warnings.
	718	+|Failure|Query or request not successful.
734	734
735	735	**QueryTypeType: **QueryType provides an enumeration of values which specify the objects in the result-set for a registry query.
736	736
...	...	@@ -738,8 +738,9 @@
738	738
739	739	Enumerations:
740	740
741		-(% style="width:739.294px" %)
742		-|(% style="width:190px" %)**Value**|(% style="width:546px" %)**Documentation**
743		-|(% style="width:190px" %)DataSets|(% style="width:546px" %)Only references data sets should be returned.
744		-|(% style="width:190px" %)MetadataSets|(% style="width:546px" %)Only references to metadata sets should be returned.
745		-|(% style="width:190px" %)AllSets|(% style="width:546px" %)References to both data sets and metadata sets should be returned.
	726	+|**Value**|**Documentation**
	727	+|DataSets|Only references data sets should be returned.
	728	+|MetadataSets|Only references to metadata sets should be returned.
	729	+|AllSets|References to both data sets and metadata sets should be returned.
	730	+
	731	+