Retrieving XML Metadata by Using a Query String
To retrieve records in XML format, append a query string to the URL for the XML Server. For example:
http://library.university.com/xmlopac/?xml=<WXREQ_ROOT><KEY>acrane</KEY></WXREQ_ROOT>
This returns all bibliographic records where the author equals crane.
Query strings can be passed to the XML Server as POST commands, making it possible for you to create Web-based forms that return Innovative system records in XML format.
Use URL encoding in query strings. URL encoding refers to the standardized representation of ASCII control characters, non-ASCII characters, etc. in URLs. More information on URL encoding can be found in reference works about Web authoring.
Query strings may contain name-value pairs, in which each pair is separated from the next pair by an ampersand (&), and the name and value are separated from each other by an equals sign (=). Query strings can also include data that is not formatted as name-value pairs, with each argument separated from the next by an encoded space.
Name-Value Pairs for XML Server Query Strings
| Name | Value | Definition | Example | Example Retrieves |
|---|---|---|---|---|
| avsparm | token%20target | WebPAC advanced boolean search help page token and the target data, separated by a URL-encoded space. | m%20b | records with a material type of book. |
| avsrank | A, D, R, or S | Advanced Search sort order: A alphabetical (by title) D date R relevance S simple search |
D | records in date order. |
| exclude | XML node.XML node.XML node... | The XML node to suppress from output. Children of the node are also suppressed. This name-value pair can be repeated by adding a new name-value pair for each node. |
WX_ROOT.PAGEINFO. WXREQ_ROOT.KEY |
results with the KEY node and its children suppressed. |
| lang | languagecode | A three-letter language code. | spa | records in Spanish. |
| limit | limit,condition,target |
A limit to apply to the retrieved records.
|
l,%3D,spa | records in Spanish. |
| links | <one-character record type>range | Includes linked records of the specified type. The range specifies which linked records of that type to return. Linked records are numbered starting with '1'. This name-value pair can be repeated by adding a new name-value pair. |
i1,4-20 | the first linked item record and the fourth through twentieth linked item records. |
| netli | 1, y, Y, t, T, 0, n, N, f, or F | Determines if results are limited to netLibrary records. Setting this value to true (1, y, Y, t, or T) limits the results to netLibrary records. Setting it to false (0, n, N, f, or F) applies no limit. | t | netLibrary records only. |
| nodtd | 1, y, Y, t, T, 0, n, N, f, or F | Determines if the DOCTYPE line is suppressed in the returned XML. Some scripts will not work if the DOCTYPE line is present. | n | XML with the DOCTYPE line suppressed. |
| noexclude | XML node.XML node.XML node... | Overrides the default suppression of all or part of the WXROOT.Heading.Title.IIIRecord nodes. This name-value pair can be repeated by adding a new name-value pair for each node. |
WXROOT.Heading. Title.IIIRecord |
results including the records under the IIIRecord node. |
| nofilter | noauth | Overrides the filter that suppresses display of authority records. | noauth | authority records. |
| scope | scope | Sets the scope. | 1 | records in scope 1. |
| staff | 1, y, Y, t, T, 0, n, N, f, or F | If set to true (1, y, Y, t, or T), overrides suppression of records and fields from public display. | t | records and fields including those suppressed from public display. |
| usepubdef | 1, y, Y, t, T, 0, n, N, f, or F | If set to true (1, y, Y, t, or T), allows suppression of records and fields from public display. | t | records and fields excluding those suppressed from public display. |
| xml | <tag>target</tag> | Use XML tags in the query string. Refer to the XML request DTD to construct query strings with the xml-xmltags name-value pair. | <WXREQ_ROOT><KEY> acrane</KEY></WXREQ_ROOT> |
records with an a-tagged field containing "crane." |