getReviewsForRecordRequest
General Purpose
Provides the reviews of a specific item
WSDL
The WSDL file is located under the following URL:
<your address>:<fe_port>/PrimoWebServices/services/reviews?wsdl
Input Parameters
| Element | Description | Value | Structure |
|---|---|---|---|
| getReviewsForRecordRequest | Root element of the XML tree | no value | root element |
| docId | record id from the PNX table | string | sub-element of getReviewsForRecordRequest |
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 | boolean | false | sub-element of Reviews |
Example Input
<getReviewsForRecordRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest\" xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents\">
<docId> demo_aleph000648308</docId>
</getReviewsForRecordRequest>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>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>