Ready to Learn?Ex Libris products all provide open APIs

General Purpose

The eshelf/remove request removes a specific item from a user's e-Shelf.

 

Input Parameters

The input is a URL string that removes specific user’s document from e-Shelf.
The following table describes the valid parameters in the URL input request:
 

ParameterDescriptionValue
userIdUser ID.string
institutionInstitution code.string
docIdRecord ID from the PNX table.string
folderIdThe folder ID of the subfolder that contains the item.string

 

Output Parameters

The output for this message is an XML response, which contains the success or failure acknowledgement for this request. The parameters that are listed in the output parameters section, such as error are part of this single XML and are not sent as separate parameters.

The following table describes the valid parameters:
 

ElementDescriptionValue
segmentsRoot element of the XML tree.no value
jagrootElement to contain one or several sub-elements.
Structure: Sub-element of segments.
no value
resultElement to contain one or several sub-elements.Structure: Sub-element of jagroot.no value
errorThis element contains the message attribute, which contains a success or failure message.string

 

Input Example

http://primo:170X/PrimoWebServices/xservice/eshelf/remove?institution=DEMO&userId=demo&docId=demo_voyager968394&folderId=basket

http://primo:170X0/PrimoWebServices/xservice/eshelf/folders?institution=DEMO&userId=demo&docId=demo_voyager968394&folderId=2345678

using XS Client
http://primo:170X0/PrimoWebServices/xsTestClient.html via ‘SEND via DELETE’
 

Output Example

<SEGMENTS xmlns="http://www.exlibrisgroup.com/xsd/jaguar/search">
    <JAGROOT>
        <RESULT>
            <ERROR MESSEGE="Remove from eshelf successfully" CODE="0"/>
        </RESULT>
    </JAGROOT>
</SEGMENTS>