RequestItem
Once a requestable item is found using FindItem, the RequestItem service allows the library to submit a request into Relais through the Discovery web services framework.
Note: This service is used only when Relais is used for request management.
Request Item
Request Item service URL:
http://HOSTNAME/dws/item/add?aid=${aid}
where ${aid} is the authorization id for the user logged in. The {aid} is provided by the Authentication service.
HTTP Method: POST
HTTP Header Content-Type: application/json
RequestItem request json
The value(s) or values to be used in the ExactSearch. If a valid Type is provided but there is no corresponding value, an error is returned: "No Value for ExactSearch Type: {type} provided."
Value | Descripción |
---|---|
PartnershipId |
Required. Partnership ID indicating to which consortium/group the library belongs. Contact Relais International for the Partnership ID. |
PickupLocation |
The pickup location selected by the patron at the time the request was submitted. A list of pickup location codes and descriptions is returned to the client in the FindItem response when the item is requestable, i.e., Available = true. |
Notes |
Any notes provided by the patron at the time the request was submitted. |
ExactSearch |
Notes:
|
Types |
Notes:
|
Value |
The value(s) to be used in the ExactSearch. If a valid Type is provided but no corresponding value and error is returned: "No Value for ExactSearch Type: {type} provided." |
BibSearch |
Notes:
|
Title |
Mandatory when BibSearch is provided. Searched as a phrase. 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. |
Excluir |
Exclude the records that match the filter(s) provided. |
BibInfo | |
ArticleTitle |
The title of the article or book chapter as entered by the patron or provided as part of the request. |
ArticleAuthor |
The author of the article or book chapter as entered by the patron or provided as part of the request. |
Volume |
The volume as entered by the patron or provided as part of the request. |
Issue |
The issue as entered by the patron or provided as part of the request. |
AdditionalNumbers |
Additional numbers as entered by the patron or provided as part of the request. |
RequestInfo | |
PublicationType |
Publication type as selected by the patron or provided as part of the request.
|
ServiceType |
Service type as selected by the patron or provided as part of the request.
|
ServiceLevel |
Service level as selected by the patron or provided as part of the request.
|
RequestSource |
Request source as selected by the patron or provided as part of the request.
|
ExternalNumber |
Request number from an external ILL management system. |
NeedByDate |
Need by date as entered by the patron. |
MaximumCost |
Maximum cost as entered by the patron. In BigDecimal type, such as 1, 2, 10.59, etc. |
DeliveryMethod |
Delivery method as selected by the patron or provided as part of the request.
|
DeliveryAddress |
Delivery address as entered by the patron or provided as part of the request. |
RequestItem response json
{ "RequestNumber":"requestNumber", "RequestLink":{ "ButtonLink":"buttonLink", "ButtonLabel":"buttonLabel", "RequestMessage":"requestMessage" } }
Note: One of RequestNumber or RequestLink will be returned, but not both.
RequestItem response - JSON elements
Element | Descripción |
---|---|
RequestNumber | The request number assigned by Relais. |
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. |
Errors
The following is a sample response for an unsuccessful request:
{
"Problem":{
"ErrorCode":"PUBRI002",
"ErrorMessage":"Invalid aid"
}
}
This service may return the following error codes and messages:
Code |
Type |
Mensaje |
---|---|---|
PUBSC001 | Público |
Invalid request The following message could be appended:
Missing required URL parameter: aid |
PUBSC005 | Público | Invalid JSON request |
PUBAZ001, PUBRI001 | Público |
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. |
PUBRI004 |
Público |
Not a valid format: {Format} |
PUBRI005 |
Público |
Could not parse valid date: {PublicationDate} |
PUBRI002 | Público | Invalid aid |
PUBSC006 | Público | User group not authorized to access the service |
PUBRI003 | Público | No result |
PRIAZ001, PRIRI001, PRISC001 | Private | Internal error |
PRIRI002 |
Private |
Error returned by the Requestability service. The error may be appended. |
PRIRI003 |
Private |
Error returned by the AddRequest service. The error may be appended. |