Remove Folder From E-Shelf
General Purpose
The eshelf remove Folder request removes a specific folder from the e-Shelf.
A success or failure acknowledgement is returned.
Input Parameters
The input is a URL string that requests to remove specific folder from user’s e-Shelf. All items from that folder are removed altogether.
The following table describes the valid parameter in the URL input request:
| Parameter | Description | Value | Mandatory |
|---|---|---|---|
| userId | PDS id of the user which the new folder belongs to | string | Yes |
| institution | Institution code. | string | No |
| folderId | the Id of the parent folder(if null will be under the root) | string | No |
| action | Remove folder | remove | Yes |
The output of this request is an XML response that contains the success or failure acknowledgement for this request. The parameters that are listed in the output parameters section, such as segments, jagroot, result etc. are part of this single XML and are not sent as separate parameters.
The following table describes the valid parameters:
| Element | Description | Value |
|---|---|---|
| segments | Root element of the XML tree. | no value |
| jagroot | Element to contain one or several sub-elements. Structure: Sub-element of segments. | no value |
| result | Element to contain one or several sub-elements. Structure: Sub-element of jagroot. | no value |
| error | This element contains the message attribute that contains a success or failure message. | string |
http://primo:170X/PrimoWebServices/xservice/eshelf/eshelf?action=REMOVE&institution=DEMO&userId=demo&folderId=2241399&action=remove // using http://primo:170X/PrimoWebServices/xsTestClient.html ‘SEND via DELETE’ http://primo:170X/PrimoWebServices/xservice/eshelf/eshelf?institution=PRIMO&userId=demo&folderId=12502
Output Example
<SEGMENTS xmlns="http://www.exlibrisgroup.com/xsd/jaguar/search">
<JAGROOT>
<RESULT>
<ERROR MESSEGE="Remove Folder from eshelf action completed successfully" CODE="0"/>
</RESULT>
</JAGROOT>
</SEGMENTS>