Add Folder to E-Shelf
General Purpose
The eshelf add Folder request adds a specific folder to the e-Shelf.
A success or failure acknowledgement is returned.
The input is a URL string that adds new folder to user’s e-Shelf. If parentFolder parameter is not provided item is added to root folder.
The following table describes the valid parameters 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 |
| folderName | the name of the new folder | string | Yes |
| folderId | the Id of the parent folder(if null will be under the root) | string | No |
| action | Using for “GET” http method only. Must not used for “PUT” http method | add | Yes |
The output for this message is an XML response that includes the requested user’s e-Shelf folders, subfolders, and basket items if requested. The parameters that are listed in the output parameters section, such as eshelf_folders, eshelf_folder_set 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:170X0/PrimoWebServices/xservice/eshelf/eshelf?institution=PRIMO&userId=demo&folderName=myNewFolder&folderId=125020&action=add // using http://primo:170X0/PrimoWebServices/xsTestClient.html ‘SEND via PUT’ http://primo:170X0/PrimoWebServices/xservice/eshelf/eshelf?institution=PRIMO&userId=demo&folderName=myNewFolder&parentFolder=125020
Output Example
<SEGMENTS xmlns="http://www.exlibrisgroup.com/xsd/jaguar/search">
<JAGROOT>
<RESULT>
<ERROR MESSEGE="Add to eshelf successfully" CODE="0"/>
</RESULT>
</JAGROOT>
</SEGMENTS>