getReviewsByRatingRequest
General Purpose
Provides the reviews of a specific user with a specific rating.
Interface Type
WSDL
The WSDL file is located under the following URL:
<your address>:<fe_port>/PrimoWebServices/services/reviews?wsdl
Input Parameters
Element | Description | Value | Default | Structure |
---|---|---|---|---|
getReviewsByRatingRequest | Root element of the XML tree | no value | root element | |
userId | user id | string | sub-element of getReviewsByRatingRequest | |
rating | rate of reviews to be returned | 1 – 10 | 1 | sub-element of getReviewsByRatingRequest |
Output Parameters
Element | Description | Value | Default | Structure |
---|---|---|---|---|
TagsAndReviews | Root element of the XML tree | no value | root element | |
Reviews | Element to contain one or several sub-elements (see structure) | no value | sub-element of TagsAndReviews | |
userId | user id | string | sub-element of Reviews | |
docId | record id from the PNX table | string | sub-element of Reviews | |
value | the review the user wrote | string | sub-element of Reviews | |
rating | rate given by the user to the Item | 1 to 10 | 1 | sub-element of Reviews |
status | status of review (0=deleted ,2= Active) | “1” to “n” | sub-element of Reviews | |
userDisplayName | name to be displayed with the review | string | sub-element of Reviews | |
allowUserName | whether user agree to display his name next to review | “false” or “true” | FALSE | sub-element of Reviews |
Example Input
<getReviewsByRatingRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest\" xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents\"> <userId>OHAD</userId> <rating>8</rating> </getReviewsByRatingRequest>
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>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>