Creating an XML Request for XML Output

You can create an XML request for XML Server output by using the "xml=xmltags" name-value pair in a query string.

If a request contains conflicting XML and URL path search parameters, the XML search parameters will be used by the system. For example, the following request returns results where the author equals "crane":

http://library.university.edu/xmlopac/asmith?xml=<WXREQ_ROOT><KEY>acrane</KEY></WXREQ_ROOT>

The XML tags used in an XML request are defined by the XML request DTD.

The XML request DTD is as follows:

<!ELEMENT WXREQ_ROOT (
    KEY?, STANDARDIZEDKEY?, INDEXSTART?, INDEXCOUNT?, RECORDSTART?,
    RECORDCOUNT?, AVSRANK?, STAFF?, NODTD?, LIMIT*, EXCLUDE*, NOEXCLUDE*,
    LINKS*, NOFILTER*, SCOPE?, LANG?, NETLI?, CIRCHIST?, AVSPARM*,
    USEPUBDEF
        ) >

<!ELEMENT KEY (#PCDATA) >
<!ELEMENT STANDARDIZEDKEY (#PCDATA) >
<!ELEMENT INDEXSTART (#PCDATA) >
<!ELEMENT INDEXCOUNT (#PCDATA) >
<!ELEMENT RECORDSTART (#PCDATA) >
<!ELEMENT RECORDCOUNT (#PCDATA) >
<!ELEMENT AVSRANK (#PCDATA) >
<!ELEMENT STAFF (#PCDATA) >
<!ELEMENT NODTD (#PCDATA) >
<!ELEMENT LIMIT (#PCDATA) >
<!ELEMENT EXCLUDE (#PCDATA) >
<!ELEMENT NOEXCLUDE (#PCDATA) >
<!ELEMENT LINKS (#PCDATA) >
<!ELEMENT NOFILTER (#PCDATA) >
<!ELEMENT SCOPE (#PCDATA) >
<!ELEMENT LANG (#PCDATA) >
<!ELEMENT NETLI (#PCDATA) >
<!ELEMENT CIRCHIST (#PCDATA) >
<!ELEMENT AVSPARM (#PCDATA) >
<!ELEMENT USEPUBDEF (#PCDATA) >

Explanation of the XML request DTD Elements

Element	Explanation	Attributes	Required
WXREQ_ROOT	The WXREQ_ROOT element contains all other elements.	None.	Yes.
KEY	This element is character data. This is typically used for the index tag and target data in the index.	None.	No.
STANDARDIZEDKEY	Not used.	None.	No.
INDEXSTART	This element is character data. This is typically used to indicate which indexed entry (also known as a heading) begins the XML output. The XML output can start at the first indexed entry or any one after it. Indexed entries are numbered starting with "1".	None.	No.
INDEXCOUNT	This element is character data. This is typically used to indicate how many indexed entries to retrieve.	None.	No.
RECORDSTART	This element is character data. This is typically used to indicate which title of an indexed entry begins the XML output. The XML output can start at the first title or any one after it. Titles are numbered starting with "1". If more than one indexed entry is retrieved, this element is ignored.	None.	No.
RECORDCOUNT	This element is character data. This is typically used to indicate how many titles to retrieve. If more than one indexed entry is retrieved, this element is ignored.	None.	No.
AVSRANK	This element is character data. This is typically used to indicate Advanced Word Search sort order. Typical values are A (alphabetical by title), D (date), R (relevance), or S (simple search).	None.	No.
STAFF	This element is character data. This is typically used to indicate if some records will be suppressed from view. True (1, Y, y, t, or T) means the records are not suppressed.	None.	No.
NODTD	This element is character data. This is typically used to indicate whether the DOCTYPE statement appears in the output. Some scripts will not work with output that contains the DOCTYPE statement. True (1, Y, y, t, or T) means the DOCTYPE statement is suppressed.	None.	No.
LIMIT	This element is character data. This is typically used to apply a limit to the retrieved records in non-AVS searches. It typically contains a letter corresponding to a menu for limiting searches, a condition such as "equal to" or "greater than", and the target data. The letter, condition, and target are separated by commas.	None.	No.
EXCLUDE	This element is character data. This is typically used for suppressing output from an XML node and its children, using the form XMLnode.XMLnode.XMLnode....	None.	No.
NOEXCLUDE	This element is character data. This is typically used to override the default suppression of some or all of the XML nodes "WXROOT.Heading.Title.IIIRecord."	None.	No.
LINKS	This element is character data. This is typically used to retrieve records linked to bibliographic records. The format is the one-character code for the record type and comma-separated numbers or number ranges that determines which of the linked records of that type are retrieved.	None.	No.
NOFILTER	This element is character data. This is typically used to override the default suppression of authority records by the "noauth" filter. Entering "noauth" overrides the suppression of authority records.	None.	No.
SCOPE	This element is character data. This is typically used to indicate the scope for retrieved records.	None.	No.
LANG	This element is character data. This is typically used for a three-character language code.	None.	No.
NETLI	This element is character data. This is typically used to determine whether the records retrieved are netLibrary records. True (1, Y, y, t, or T) means the retrieved records are netLibrary records.	None.	No.
CIRCHIST	Not used.	None.	No.
AVSPARM	This element is character data. This is typically used to apply a limit to the retrieved records in AVS searches.	None.	No.
USEPUBDEF	This element is character data. This is typically used to determine whether some records are suppressed from public view. True (1, Y, y, t, or T) means the records are suppressed.	None.	No.