Ready to Learn?Ex Libris products all provide open APIs

General Purpose

The reviews/get request returns reviews for a specific item.

 

Input Parameters

ElementDescriptionValue
userIdUser ID.string
docIdRecord id from the PNX table.string

 

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: fals

 

Input Example

http://primo:170X/PrimoWebServices/xservice/reviews/get?userId=demo&docId=demo_voyager968394

 

Output Example

<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>