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

From version 3.1
edited by Helena
on 2025/06/26 14:14
Change comment: There is no comment for this version
To version 3.2
edited by Helena
on 2025/06/26 14:20
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,6 @@
1 1  {{box title="**Contents**"}}
2 2  {{toc/}}
3 3  {{/box}}
4 -
5 5  
6 6  = 1. Introduction =
7 7  
... ... @@ -10,6 +10,7 @@
10 10  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.
11 11  
12 12  = 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,6 +17,7 @@
17 17  === 2.1.1 Summary ===
18 18  
19 19  Referenced Namespaces:
20 +
20 20  |**Namespace**|**Prefix**
21 21  |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
22 22  |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure|str
... ... @@ -37,6 +37,7 @@
37 37  ProvisionAgreement, Datasource
38 38  
39 39  Attribute Documentation:
41 +
40 40  |**Name**|**Type**|**Documentation**
41 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 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.
... ... @@ -48,6 +48,7 @@
48 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.
49 49  
50 50  Element Documentation:
53 +
51 51  |**Name**|**Type**|**Documentation**
52 52  |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement provides a reference to the provision agreement that the data is being registered against.
53 53  |Datasource|DataSourceType|Datasource identifies the data source(s) where the registered data can be retrieved.
... ... @@ -58,6 +58,7 @@
58 58  (SimpleDataSource | QueryableDataSource)[1..2]
59 59  
60 60  Element Documentation:
64 +
61 61  |**Name**|**Type**|**Documentation**
62 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 63  |QueryableDataSource|QueryableDataSourceT ype|QueryableDatasource describes a data source that must be able to accept an SDMX-ML Query Message, and respond appropriately.
... ... @@ -65,6 +65,7 @@
65 65  **SimpleDataSourceType: **SimpleDataSourceType describes a simple data source. The URL of the data is contained in the content.
66 66  
67 67  Derivation:
72 +
68 68  * xs:anySimpleType (restriction)
69 69  ** xs:anyURI (extension)
70 70  *** SimpleDataSourceType
... ... @@ -81,6 +81,7 @@
81 81  **QueryableDataSourceType: **QueryableDataSourceType describes a queryable data source, and add a fixed attribute for ensuring only one queryable source can be provided.
82 82  
83 83  Derivation:
89 +
84 84  * com:QueryableDataSourceType (extension)
85 85  ** QueryableDataSourceType
86 86  
... ... @@ -91,6 +91,7 @@
91 91  com:DataURL, com:WSDLURL?, com:WADLURL?
92 92  
93 93  Attribute Documentation:
100 +
94 94  |**Name**|**Type**|**Documentation**
95 95  |isRESTDatasource|xs:boolean|The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
96 96  |isWebServiceDatasource|xs:boolean|The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
... ... @@ -97,6 +97,7 @@
97 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.
98 98  
99 99  Element Documentation:
107 +
100 100  |**Name**|**Type**|**Documentation**
101 101  |com:DataURL|xs:anyURI|DataURL contains the URL of the data source.
102 102  |com:WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
... ... @@ -111,6 +111,7 @@
111 111  {Empty}
112 112  
113 113  Attribute Documentation:
122 +
114 114  |**Name**|**Type**|**Documentation**
115 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.
116 116  
... ... @@ -117,6 +117,7 @@
117 117  **VersionableQueryType: **VersionableQueryType describes the structure of a query for a versionable object.
118 118  
119 119  Derivation:
129 +
120 120  * IdentifiableQueryType (extension)
121 121  ** VersionableQueryType
122 122  
... ... @@ -127,6 +127,7 @@
127 127  {Empty}
128 128  
129 129  Attribute Documentation:
140 +
130 130  |**Name**|**Type**|**Documentation**
131 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 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.
... ... @@ -134,6 +134,7 @@
134 134  **MaintainableQueryType: **MaintainableQueryType describes the structure of a query for a maintainable object.
135 135  
136 136  Derivation:
148 +
137 137  * IdentifiableQueryType (extension)
138 138  ** VersionableQueryType (extension)
139 139  *** MaintainableQueryType
... ... @@ -145,6 +145,7 @@
145 145  {Empty}
146 146  
147 147  Attribute Documentation:
160 +
148 148  |**Name**|**Type**|**Documentation**
149 149  |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.
150 150  |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.
... ... @@ -159,10 +159,12 @@
159 159  MessageText*
160 160  
161 161  Attribute Documentation:
175 +
162 162  |**Name**|**Type**|**Documentation**
163 163  |status|StatusType|The status attribute carries the status of the query or request.
164 164  
165 165  Element Documentation:
180 +
166 166  |**Name**|**Type**|**Documentation**
167 167  |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.
168 168  
... ... @@ -172,6 +172,7 @@
172 172  RegistrationRequest+
173 173  
174 174  Element Documentation:
190 +
175 175  |**Name**|**Type**|**Documentation**
176 176  |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.
177 177  
... ... @@ -184,10 +184,12 @@
184 184  Registration
185 185  
186 186  Attribute Documentation:
203 +
187 187  |**Name**|**Type**|**Documentation**
188 188  |action|com:ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a registration.
189 189  
190 190  Element Documentation:
208 +
191 191  |**Name**|**Type**|**Documentation**
192 192  |Registration|RegistrationType|Registration contains the details of the data/metadata set registration to be added, updated, or deleted.
193 193  
... ... @@ -197,6 +197,7 @@
197 197  RegistrationStatus+
198 198  
199 199  Element Documentation:
218 +
200 200  |**Name**|**Type**|**Documentation**
201 201  |RegistrationStatus|RegistrationStatusTy pe|RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.
202 202  
... ... @@ -206,6 +206,7 @@
206 206  Registration, StatusMessage
207 207  
208 208  Element Documentation:
228 +
209 209  |**Name**|**Type**|**Documentation**
210 210  |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.
211 211  |StatusMessage|StatusMessageType|StatusMessage provides that status for the registration request, and if necessary, any error or warning information.
... ... @@ -219,10 +219,12 @@
219 219  QueryType, (All | ProvisionAgreement | DataProvider | Dataflow | Metadataflow), ReferencePeriod?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*
220 220  
221 221  Attribute Documentation:
242 +
222 222  |**Name**|**Type**|**Documentation**
223 223  |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.
224 224  
225 225  Element Documentation:
247 +
226 226  |**Name**|**Type**|**Documentation**
227 227  |QueryType|QueryTypeType|QueryType defines the type of sets (data, metadata, or both) that are being queried for.
228 228  |All|com:EmptyType|All indicates that all registrations meeting the other criteria of the query should be returned.
... ... @@ -242,6 +242,7 @@
242 242  StatusMessage, QueryResult*
243 243  
244 244  Element Documentation:
267 +
245 245  |**Name**|**Type**|**Documentation**
246 246  |StatusMessage|StatusMessageType|StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.
247 247  |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.
... ... @@ -255,10 +255,12 @@
255 255  (DataResult | MetadataResult)
256 256  
257 257  Attribute Documentation:
281 +
258 258  |**Name**|**Type**|**Documentation**
259 259  |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.
260 260  
261 261  Element Documentation:
286 +
262 262  |**Name**|**Type**|**Documentation**
263 263  |DataResult|ResultType|
264 264  |MetadataResult|ResultType|
... ... @@ -269,6 +269,7 @@
269 269  Registration, ContentConstraint*
270 270  
271 271  Element Documentation:
297 +
272 272  |**Name**|**Type**|**Documentation**
273 273  |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.
274 274  |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.
... ... @@ -282,11 +282,13 @@
282 282  (StructureLocation | str:Structures), SubmittedStructure*
283 283  
284 284  Attribute Documentation:
311 +
285 285  |**Name**|**Type**|**Documentation**
286 286  |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.
287 287  |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.
288 288  
289 289  Element Documentation:
317 +
290 290  |**Name**|**Type**|**Documentation**
291 291  |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.
292 292  |str:Structures|str:StructuresType|Structures allows for the inline definition of structural components for submission.
... ... @@ -301,11 +301,13 @@
301 301  MaintainableObject
302 302  
303 303  Attribute Documentation:
332 +
304 304  |**Name**|**Type**|**Documentation**
305 305  |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.
306 306  |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.
307 307  
308 308  Element Documentation:
338 +
309 309  |**Name**|**Type**|**Documentation**
310 310  |MaintainableObject|com: MaintainableReferenc eType|
311 311  
... ... @@ -315,6 +315,7 @@
315 315  SubmissionResult+
316 316  
317 317  Element Documentation:
348 +
318 318  |**Name**|**Type**|**Documentation**
319 319  |SubmissionResult|SubmissionResultType|SubmissionResult provides a status for each submitted structural object.
320 320  
... ... @@ -324,6 +324,7 @@
324 324  SubmittedStructure, StatusMessage
325 325  
326 326  Element Documentation:
358 +
327 327  |**Name**|**Type**|**Documentation**
328 328  |SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.
329 329  |StatusMessage|StatusMessageType|StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.
... ... @@ -334,6 +334,7 @@
334 334  SubscriptionRequest+
335 335  
336 336  Element Documentation:
369 +
337 337  |**Name**|**Type**|**Documentation**
338 338  |SubscriptionRequest|SubscriptionRequestT ype|
339 339  
... ... @@ -362,10 +362,12 @@
362 362  Subscription
363 363  
364 364  Attribute Documentation:
398 +
365 365  |**Name**|**Type**|**Documentation**
366 366  |action|com:ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.
367 367  
368 368  Element Documentation:
403 +
369 369  |**Name**|**Type**|**Documentation**
370 370  |Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.
371 371  
... ... @@ -375,6 +375,7 @@
375 375  SubscriptionStatus+
376 376  
377 377  Element Documentation:
413 +
378 378  |**Name**|**Type**|**Documentation**
379 379  |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.
380 380  
... ... @@ -384,6 +384,7 @@
384 384  SubscriptionURN?, SubscriberAssignedID?, StatusMessage
385 385  
386 386  Element Documentation:
423 +
387 387  |**Name**|**Type**|**Documentation**
388 388  |SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.
389 389  |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.
... ... @@ -395,6 +395,7 @@
395 395  Organisation
396 396  
397 397  Element Documentation:
435 +
398 398  |**Name**|**Type**|**Documentation**
399 399  |Organisation|com: OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.
400 400  
... ... @@ -404,6 +404,7 @@
404 404  StatusMessage, Subscription*
405 405  
406 406  Element Documentation:
445 +
407 407  |**Name**|**Type**|**Documentation**
408 408  |StatusMessage|StatusMessageType|StatusMessage provides that status for the query subscription request, and if necessary, any error or warning information.
409 409  |Subscription|SubscriptionType|Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.
... ... @@ -414,6 +414,7 @@
414 414  EventTime, (ObjectURN | RegistrationID), SubscriptionURN, EventAction, (StructuralEvent | RegistrationEvent)?
415 415  
416 416  Element Documentation:
456 +
417 417  |**Name**|**Type**|**Documentation**
418 418  |EventTime|xs:dateTime|EventTime specifies the time of the triggering event.
419 419  |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.
... ... @@ -426,6 +426,7 @@
426 426  **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.
427 427  
428 428  Derivation:
469 +
429 429  * xs:anySimpleType (restriction)
430 430  ** xs:anyURI (extension)
431 431  *** NotificationURLType
... ... @@ -436,6 +436,7 @@
436 436  Content:
437 437  
438 438  Attribute Documentation:
480 +
439 439  |**Name**|**Type**|**Documentation**
440 440  |isSOAP (default: false)|xs:boolean|The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.
441 441  
... ... @@ -445,6 +445,7 @@
445 445  StartDate, EndDate
446 446  
447 447  Element Documentation:
490 +
448 448  |**Name**|**Type**|**Documentation**
449 449  |StartDate|xs:date|StartDate is an inclusive start date for the subscription.
450 450  |EndDate|xs:date|EndDate is an inclusive end date for the subscription.
... ... @@ -455,6 +455,7 @@
455 455  (StructuralRepositoryEvents | DataRegistrationEvents | MetadataRegistrationEvents)[1..3]
456 456  
457 457  Element Documentation:
501 +
458 458  |**Name**|**Type**|**Documentation**
459 459  |StructuralRepository Events|StructuralRepository EventsType|StructuralRepositoryEvents details structural events for the subscription.
460 460  |DataRegistrationEven ts|DataRegistrationEven tsType|DataRegistrationEvents details the data registration events for the subscription.
... ... @@ -469,10 +469,12 @@
469 469  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)+)
470 470  
471 471  Attribute Documentation:
516 +
472 472  |**Name**|**Type**|**Documentation**
473 473  |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.
474 474  
475 475  Element Documentation:
521 +
476 476  |**Name**|**Type**|**Documentation**
477 477  |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.
478 478  |AllEvents|com:EmptyType|AllEvents creates a subscription to structural events for all structural objects maintained by the agencies referenced.
... ... @@ -507,6 +507,7 @@
507 507  (All | URN | ID)
508 508  
509 509  Element Documentation:
556 +
510 510  |**Name**|**Type**|**Documentation**
511 511  |All|com:EmptyType|All subscribes to the events all instances of the containing object meeting the other criteria specified.
512 512  |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.
... ... @@ -518,6 +518,7 @@
518 518  (All | URN | (ID, Version))
519 519  
520 520  Element Documentation:
568 +
521 521  |**Name**|**Type**|**Documentation**
522 522  |All|com:EmptyType|All subscribes to the events all instances of the containing object meeting the other criteria specified.
523 523  |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.
... ... @@ -533,10 +533,12 @@
533 533  (AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | DataflowReference | KeyFamilyReference | Category)+)
534 534  
535 535  Attribute Documentation:
584 +
536 536  |**Name**|**Type**|**Documentation**
537 537  |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.
538 538  
539 539  Element Documentation:
589 +
540 540  |**Name**|**Type**|**Documentation**
541 541  |AllEvents|com:EmptyType|AllEvents subscribes to all data registration events in the repository.
542 542  |RegistrationID|com:IDType|RegistrationID subscribes to all the data registration events for the unique registration referenced.
... ... @@ -555,10 +555,12 @@
555 555  (AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | MetadataflowReference | MetadataStructureDefinitionReference | Category)+)
556 556  
557 557  Attribute Documentation:
608 +
558 558  |**Name**|**Type**|**Documentation**
559 559  |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.
560 560  
561 561  Element Documentation:
613 +
562 562  |**Name**|**Type**|**Documentation**
563 563  |AllEvents|com:EmptyType|AllEvents subscribes to all metadata registration events in the repository.
564 564  |RegistrationID|com:IDType|RegistrationID subscribes to all the metadata registration events for the unique registration referenced.
... ... @@ -574,6 +574,7 @@
574 574  (URN | Ref)
575 575  
576 576  Element Documentation:
629 +
577 577  |**Name**|**Type**|**Documentation**
578 578  |URN|xs:anyURI|URN provides an explicit reference to a single object.
579 579  |Ref|MaintainableQueryTyp e|Ref provides a reference to potentially many object through the use of possible wild-carded reference fields.
... ... @@ -584,6 +584,7 @@
584 584  str:Structures
585 585  
586 586  Element Documentation:
640 +
587 587  |**Name**|**Type**|**Documentation**
588 588  |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.
589 589  
... ... @@ -593,6 +593,7 @@
593 593  Registration
594 594  
595 595  Element Documentation:
650 +
596 596  |**Name**|**Type**|**Documentation**
597 597  |Registration|RegistrationType|Registration provides the changed details of the data or metadata registration.
598 598  
... ... @@ -618,6 +618,7 @@
618 618  Derived by restriction of xs:NMTOKEN .
619 619  
620 620  Enumerations:
676 +
621 621  |**Value**|**Documentation**
622 622  |Success|Query or request successful.
623 623  |Warning|Query or request successful, but with warnings.