Ready to Learn?Ex Libris products all provide open APIs

General Purpose

The reviews/getReviewsByRating request returns the reviews that have a specific rating.

 

Input Parameters

ElementDescriptionValue
userIdUser id.string
ratingRate given by the user to the Item.1 to 10 
Default: 1
 

Output Parameters

ElementDescriptionValue
TagsAndReviewsRoot element of the XML tree.no value
ReviewsElement to contain one or several sub-elements. 
Structure: Sub-element of TagsAndReviews.
no value
userIdUser id. 
Structure: Sub-element of Reviews.
string
docIdRecord id from the PNX table. 
Structure: Sub-element of Reviews.
string
valueThe user's review to be added. 
Structure: Sub-element of Reviews.
string
ratingRate given by the user to the Item. 
Structure: Sub-element of Reviews.
1 to 10 
Default: 1
statusstatus of review (0=deleted ,2= Active)"1" to "n"
userDisplayNameName to be displayed with the review. 
Structure: Sub-element of Reviews.
string
allowUserNameWhether user agree to display his name next to review. 
Structure: Sub-element of Reviews.
"false" or "true" 
Default: false
 

Input Example

http://primo:170X/PrimoWebServices/xservice/reviews/getReviewsByRating?userId=OHAD&rating=8

 

Output Example

<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>recommended reading</value>

      <docId>demo_aleph000462701</docId>

      <userId>OHAD</userId>

      <status>2</status>

      <rating>8</rating>

      <userDisplayName>Ohad</userDisplayName>

      <allowUserName>true</allowUserName>

    </Review>

  </Reviews>

</TagsAndReviews>