Ready to Learn?Ex Libris products all provide open APIs

Get Reviews for Record Request

General Purpose

Provides the reviews of a specific item
 
 

WSDL

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

 

Input Parameters

ElementDescriptionValueStructure
getReviewsForRecordRequestRoot element of the XML treeno valueroot element
docIdrecord id from the PNX tablestringsub-element of getReviewsForRecordRequest
 
 

Output

 
ElementDescriptionValueDefaultStructure
TagsAndReviewsRoot element of the XML treeno value root element
ReviewsElement to contain one or several sub-elements (see structure)no value sub-element of TagsAndReviews
userIduser idstring sub-element of Reviews
docIdrecord id from the PNX tablestring sub-element of Reviews
valuethe user's review to be addedstring sub-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 reviewstring sub-element of Reviews
allowUserNamewhether user agree to display his name next to reviewbooleanfalsesub-element of Reviews

 

Example Input

<getReviewsForRecordRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest\"  xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents\">
      <docId> demo_aleph000648308</docId>
</getReviewsForRecordRequest>

 

Example Output

<TagsAndReviews xmlns="http://com/exlibris/primo/xsd/tagsAndReview/config">
  <Reviews>
    <Review>
      <value>interesting reading</value>
      <docId>demo_aleph000648308</docId>
      <userId>OHAD</userId>
      <status>2</status>
      <rating>8</rating>
      <userDisplayName>Ohad</userDisplayName>
      <allowUserName>true</allowUserName>
    </Review>
    <Review>
      <value>great book</value>
      <docId>demo_aleph000648308</docId>
      <userId>demo</userId>
      <status>2</status>
      <rating>10</rating>
      <userDisplayName>demo</userDisplayName>
      <allowUserName>true</allowUserName>
    </Review>
  </Reviews>
</TagsAndReviews>