getReviewsRequest
General Purpose
Provides the reviews of a specific item
WSDL
The WSDL file is located under the following URL:
< your address>:<port>/PrimoWebServices/services/reviews?wsdl
Input Parameters
Element | Description | Value | Structure |
---|---|---|---|
getReviewsRequest | Root element of the XML tree | no value | root element |
userId | user id | string | sub-element of getReviewsRequest |
docId | record id from the PNX table | string | sub-element of getReviewsRequest |
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 user’s review to be added | 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
<getReviewsRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest" xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents\"> <docId>White_Shore_Voyager18005</docId> <userId>CPM</userId> </getReviewsRequest>
Example Output
<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>