Get Reviews for Record

Ex Libris Developer Network Primo Documentation Primo REST APIs Web Services – Legacy X-Services Reviews Get Reviews for Record

General Purpose

The reviews/getReviewsForRecord returns the reviews for a specific item.

Input Parameters

Element	Description	Value
docId	Record id from the PNX table.	string

Output Parameters

Element	Description	Value
TagsAndReviews	Root element of the XML tree.	no value
Reviews	Element to contain one or several sub-elements. Structure: Sub-element of TagsAndReviews.	no value
userId	User id. Structure: Sub-element of Reviews.	string
docId	Record id from the PNX table. Structure: Sub-element of Reviews.	string
value	The user’s review to be added. Structure: Sub-element of Reviews.	string
rating	Rate given by the user to the Item. Structure: Sub-element of Reviews.	1 to 10 Default: 1
status	status of review (0=deleted ,2= Active)	“1” to “n”
userDisplayName	Name to be displayed with the review. Structure: Sub-element of Reviews.	string
allowUserName	Whether 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/getReviewsForRecord?docId=demo_aleph000648308

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