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.

Input Parameters

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:

userIdPDS id of the user which the new folder belongs tostringYes
institutionInstitution code.stringNo
folderNamethe name of the new folderstringYes
folderIdthe Id of the parent folder(if null will be under the root)stringNo
actionUsing for “GET” http method only. Must not used for “PUT” http methodaddYes

Output Parameters

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:

segmentsRoot element of the XML 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 that contains a success or failure message.string

Input Example


// using http://primo:170X0/PrimoWebServices/xsTestClient.html ‘SEND via PUT’


Output Example

<SEGMENTS xmlns="">
      <ERROR MESSEGE="Add to eshelf successfully" CODE="0"/>