Note: FindItem uses the aid obtained using the Authentication service. Patron credentials can not be sent as part of FindItem.
FindItem service URL:
${aid} is the authorization ID for the user logged in. The {aid} value is provided by the Authentication service.
For example:
HTTP Method: POST
HTTP Header Content-Type: application/json
Element | Description |
---|---|
PartnershipId |
Required. Partnership ID indicating to which consortium/group the library belongs.
|
ExactSearch |
Notes:
|
Type |
The type of exact search to be used. Supported options are:
If there are hyphens in the ISBN they are dropped.
If there are alpha characters at the end of the ISBN they are dropped, unless the alpha character is an X.
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.
If multiple ISBNs are provided, they are combined using OR logic. |
BibSearch |
Notes:
|
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 |
Commas and periods will be replaced with a space. Any initials are dropped.
the following keywords are dropped: author, editor, edited by, and DR.
Dates are dropped.
|
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.
For publication dates, the four digit year is extracted based on the valid dates configured.
|
Format |
Include the records that match the format(s) provided.
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.
For publication dates, the four digit year is extracted based on the valid dates configured.
|
Format |
Exclude the records that match the format(s) provided.
The value for format must be from the configurable list of formats supported. |
Element | Description |
---|---|
Available |
Depending on the results of the Requestability evaluation, a true or false value is returned.
|
RequestLink | |
ButtonLink |
The ButtonLink used depends on the results of the Requestability evaluation. The following options are possible:
These links are taken from the library's configuration. |
ButtonLabel |
The text to display for the link.
This text is taken from the library’s configuration. |
RequestMessage |
A configurable message that accompanies the button described above.
The text of this message is taken from the library’s configuration. |
OrigNumberOfRecords | The original number of bibliographic records returned by the search, i.e., before any records are merged. |
PickupLocation | PickupLocation is only included when Available = true. |
PickupLocationCode | A list of pickup location codes (as used in Relais). |
PickupLocationDescription | A list of pickup locations to display when AddRequest is used in the ButtonLink. |
FindItem response "successful" - template (for download)
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, PUBFI001 | 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.
|
PUBFI004 | Public | Not a valid format: {Format} |
PUBFI005 | Public | Could not parse valid date: {PublicationDate} |
PUBFI003 | Public | Invalid aid |
PUBSC006 | Public | User group not authorized to access the service |
PUBFI002 | Public | No result |
PRIAZ001, PRIFI001, PRISC001 | Private | Internal error has occurred in FindItem |
PRIFI002 | Private | Requestability error |
Note: PRIFI002: is used for a Requestability error, if Requestability returns an error (Problem), this error message may be appended.
The following is a sample response for an unsuccessful FindItem request:
{ "Problem": { "ErrorCode": "PUBFI001", "ErrorMessage": "PartnershipId is required" } }