SRW Diagnostics

Version 1.1, 12th January 2004

Introduction

These are the diagnostics defined for use with SRW. The Number is the code to be returned to identify the diagnostic. The details format is what should be returned in the details field. If this is blank then the format is undefined and the server may return whatever it feels appropriate, including nothing. Some of the diagnostics from earlier versions have been deprecated, however they are still listed here, suitably marked, for reference.

Defined Diagnostics


General Diagnostics
NumberDescriptionDetails Format
1General system errorDebugging information (traceback)
2System temporarily unavailable
3Authentication error
4Unsupported operation
5Unsupported versionHighest version supported
6Unsupported parameter valueName of parameter
7Mandatory parameter not suppliedName of missing parameter
8Unknown databaseName of database

Diagnostics Relating to CQL
NumberDescriptionDetails Format
10Query syntax error
11DEPRECATED. Unsupported query type
12DEPRECATED. Too many characters in query
13Unsupported use of parenthesesCharacter offset to error
14Unsupported use of quotesCharacter offset to error
15Unsupported context setURI or short name of context set
16Unsupported indexName of index
17DEPRECATED. Unsupported combination of index and index set
18Unsupported combination of indexesSpace delimited index names
19Unsupported relationRelation
20Unsupported relation modifierValue
21Unsupported combination of relation modifersSlash separated relation modifiers
22Unsupported combination of relation and indexSpace separated index and relation
23Too many characters in termLength of longest term
24Unsupported combination of relation and termSpace separated relation and term
25DEPRECATED. Special characters not quoted in term
26Non special character escaped in termCharacter incorrectly escaped
27Empty term unsupported
28Masking character not supported
29Masked words too shortMinimum word length
30Too many masking characters in termMaximum number supported
31Anchoring character not supported
32Anchoring character in unsupported positionCharacter offset
33Combination of proximity/adjacency and masking characters not supported
34Combination of proximity/adjacency and anchoring characters not supported
35Term contains only stopwordsValue
36Term in invalid format for index or relation
37Unsupported boolean operatorValue
38Too many boolean operators in queryMaximum number supported
39Proximity not supported
40Unsupported proximity relationValue
41Unsupported proximity distanceValue
42Unsupported proximity unitValue
43Unsupported proximity orderingValue
44Unsupported combination of proximity modifiersSlash separated values
45DEPRECATED. Prefix assigned to multiple identifiers
46Unsupported boolean modifierValue

Diagnostics Relating to Result Sets
NumberDescriptionDetails Format
50Result sets not supported
51Result set does not existResult set identifier
52Result set temporarily unavailableResult set identifier
53Result sets only supported for retrieval
54DEPRECATED. Retrieval may only occur from an existing result set
55Combination of result sets with search terms not supported
56DEPRECATED. Only combination of single result set with search terms supported
57DEPRECATED. Result set created but no records available
58Result set created with unpredictable partial results available
59Result set created with valid partial results available
60Result set not created: too many matching recordsMaximum number

Diagnostics Relating to Records
NumberDescriptionDetails Format
61First record position out of range
62DEPRECATED. Negative number of records requested
63DEPRECATED. System error in retrieving records
64Record temporarily unavailable
65Record does not exist
66Unknown schema for retrievalSchema URI or short name
67Record not available in this schemaSchema URI or short name
68Not authorised to send record
69Not authorised to send record in this schema
70Record too large to sendMaximum record size
71Unsupported record packing
72XPath retrieval unsupported
73XPath expression contains unsupported featureFeature
74Unable to evaluate XPath expression

Diagnostics Relating to Sorting
NumberDescriptionDetails Format
80Sort not supported
81DEPRECATED. Unsupported sort type
82Unsupported sort sequenceSequence
83Too many records to sortMaximum number supported
84Too many sort keys to sortMaximum number supported
85DEPRECATED. Duplicate sort keys
86Cannot sort: incompatible record formats
87Unsupported schema for sortURI or short name of schema given
88Unsupported path for sortXPath
89Path unsupported for schemaXPath
90Unsupported directionValue
91Unsupported caseValue
92Unsupported missing value actionValue

Diagnostics Relating to Explain
NumberDescriptionDetails Format
100DEPRECATED. Explain not supported (Use 4)
101DEPRECATED. Explain request type not supported
102DEPRECATED. Explain record temporarily unavailable (Use 64)

Diagnostics relating to Stylesheets
NumberDescriptionDetails Format
110Stylesheets not supported
111Unsupported stylesheetURL of stylesheet

Diagnostics relating to Scan
NumberDescriptionDetails Format
120Response position out of range