Add Review
General Purpose
The reviews/add request adds a review to specific item.
A success or failure acknowledgement is returned.
Input Parameters
| Parameter | Description | Value |
|---|---|---|
| userId | User ID. | string |
| docId | Record id from the PNX table. | string |
| institution | Institution code | string |
| value | The user’s review to be added. | string |
| rating | Rate given by the user to the Item. | 1 – 10 Default: 1 |
| userDisplayName | Name to be displayed with the review. | string |
| allowUserName | Whether user agrees to display his name next to review. | “true” or “false” Default: false |
| status | Define the status of the review. The valid value is 2. | string |
Output Parameters
The output of this request contains the success or failure acknowledgement for this request.
The following table describes the valid parameters:
| Element | Description | Value |
|---|---|---|
| TagsAndReviews | Root element of the XML tree. | no value |
| error | This element contains the message attribute, which contains a success or failure message. | string |
Input Example
http://<primo server>:<primo port>/PrimoWebServices/xservice/reviews/add?value=good55&userId=ohad&institution=VOLCANO&docId=White_Shore_Voyager20786&rating=4&userDisplayName=Ohad&allowUserName=true&status=2
Output Example
<TagsAndReviews> <ERROR CODE="0" MESSAGE="Add review action completed successfully"/> </TagsAndReviews>