getReviewsRequest

General Purpose

Provides the reviews of a specific item

WSDL

The WSDL file is located under the following URL:
< your address>:<port>/PrimoWebServices/services/reviews?wsdl

Input Parameters

ElementDescriptionValueStructure
getReviewsRequestRoot element of the XML treeno valueroot element
userIduser idstringsub-element of getReviewsRequest
docIdrecord id from the PNX tablestringsub-element of getReviewsRequest

Output Parameters

ElementDescriptionValueDefaultStructure
TagsAndReviewsRoot element of the XML treeno valueroot element
ReviewsElement to contain one or several sub-elements (see structure)no valuesub-element of TagsAndReviews
userIduser idstringsub-element of Reviews
docIdrecord id from the PNX tablestringsub-element of Reviews
valuethe user’s review to be addedstringsub-element of Reviews
ratingrate given by the user to the Item1 to 101sub-element of Reviews
statusstatus of review (0=deleted ,2= Active)“1” to “n”sub-element of Reviews
userDisplayNamename to be displayed with the reviewstringsub-element of Reviews
allowUserNamewhether user agree to display his name next to review“false” or “true”FALSEsub-element of Reviews

Example Input

<getReviewsRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest" xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents\">
    <docId>White_Shore_Voyager18005</docId>
    <userId>CPM</userId>
</getReviewsRequest>

Example Output

<TagsAndReviews xmlns="http://com/exlibris/primo/xsd/tagsAndReview/config">
   <Reviews>
      <Review>
         <value>good55</value>
         <docId>demo_voyager968394</docId>
         <userId>demo</userId>
         <status>2</status>
         <rating>2</rating>
         <userDisplayName>Hila</userDisplayName>
         <allowUserName>true</allowUserName>
      </Review>
   </Reviews>
</TagsAndReviews>