Search catalog

Find information about using the SearchCatalog for testing and troubleshooting FindItem in Relais ILL.

The SearchCatalog is used when testing and troubleshooting FindItem. It is comparable to FindItem but returns in XML detailed bibliographic information from the record retrieved.

SearchCatalog uses the 'aid' (obtained using the Authentication service). Patron credentials can not be sent as part of SearchCatalog.

SearchCatalog

SearchCatalog service URL:

http://HOSTNAME/dws/catalog/search?aid=${aid}

where ${aid} is the authorization id for the user logged in. The {aid} is provided by the Authentication service.

For example:

http://HOSTNAME/dws/catalog/search?aid=YkbOGfBGv6hKLefABkWJP2yYlI8

HTTP Method: POST
HTTP Header Content-Type: application/json

SearchCatalog request body - JSON elements

Element	Description
PartnershipId	Partnership ID indicating to which consortium/group the library belongs. Contact OCLC Support for your Partnership ID. Required.
ExactSearch	Note: One of ExactSearch or BibSearch must be provided. Only one of ExactSearch or BibSearch may be provided.
Type	The type of exact search to be used. Supported options are: ISBN (repeatable) ISSN (repeatable) LCCN OCLC Notes: Values are case-sensitive. If an invalid Type is supplied, then an error is returned: Invalid Type: {type} provided. If there are hyphens in the ISBN they are dropped. Example: ISBN 1-4380-7071-3 becomes 1438070713 If there are alpha characters at the end of the ISBN they are dropped, unless the alpha character is an X. Examples: ISBN 0060621273PBK. becomes 0060621273 ISBN 0-8131-2414-X becomes 081312414X If there is punctuation within the ISBN that is listed in the ID_SPECIAL_CHAR table, the punctuation and any characters after it are dropped. Example: ISBN 9781572247055;157 becomes 9781572247055 If multiple ISBNs are provided, they are combined using OR logic
BibSearch	Notes: One of ExactSearch or BibSearch must be provided. Only one of ExactSearch or BibSearch may be provided.
Title	Mandatory when BibSearch is provided. The title is searched as a phrase. No cleanup, such as the removal of special characters, is done prior to the search.
Author	Repeatable. Commas and periods will be replaced with a space. Any initials are dropped. Example: For DICKSON, BRUCE J. the keywords = DICKSON and BRUCE are used. the following keywords are dropped: author, editor, edited by, and DR. Example: For Begun, David R, the keywords Begun and David are used. Dates are dropped. Example: For Enterline, Lynn, 1956-, the keywords Enterline and Lynn are used.
ResultFilter	Date and format filters can be used to narrow the results. Only one of Include and Exclude filters may be provided.
Include	Include the records that match the filter(s) provided.
PublicationDate	Include the records that match the year(s) provided. Repeatable For publication dates, the four digit year is extracted based on the valid dates configured. Example: For c2013, the date 2013 is used. For 2015-01-01 the date 2015 is used.
Format	Include the records that match the format(s) provided. Repeatable The value for format must be from the configurable list of formats supported.
Exclude	Exclude the records that match the filter(s) provided.
PublicationDate	Exclude the records that match the year(s) provided. Repeatable For publication dates, the four digit year is extracted based on the valid dates configured. Example: For c2013, the date 2013 is used. For 2015-01-01 the date 2015 is used.
Format	Exclude the records that match the format(s) provided. Repeatable The value for format must be from the configurable list of formats supported.

SearchCatalog request - template (for download)

SearchCatalog response

The response for SearchCatalog is returned as XML. It includes bibliographic, item and locations information if a record is retrieved.

SearchCatalog response - template (for download)

Errors

FindItem may return the following error codes and messages:

Code	Type	Message
PUBSC001	Public	Invalid request The following message could be appended: Missing required URL parameter: aid
PUBSC005	Public	Invalid JSON request
PUBAZ001, PUBSC001, PUBSC002	Public	Missing parameter The following message could be appended: PartnershipId is required ExactSearch or BibSearch is required Invalid Type: {Type} provided. No Value for ExactSearch Type: {Type} provided. No title provided. PublicationDate provided in Include and Exclude filters. Format provided in Include and Exclude filters.
PUBCS003	Public	Not a valid format: {Format}
PUBCS004	Public	Could not parse valid date: {PublicationDate}
PUBSC004	Public	Invalid aid
PUBSC006	Public	User group not authorized to access the service
PUBCS002	Public	No result
PRIAZ001, PRICS001, PRISC001	Private	Internal Error

The following is a sample response for an unsuccessful FindItem request:

        <?xml version="1.0" encoding="UTF-8"?>
        <Problem>  
            <ErrorCode>PUBSC002</ErrorCode>
            <ErrorMessage>PartnershipId is required</ErrorMessage>
        </Problem>