Ready to Learn?Ex Libris products all provide open APIs

General Purpose

The reviews/add request adds a review to specific item

A success or failure acknowledgement is returned.

Input Parameters

ParameterDescriptionValue
userIdUser ID.string
docIdRecord id from the PNX table.string
institutionInstitution codestring
valueThe user's review to be added.string
ratingRate given by the user to the Item.1 - 10
Default: 1
userDisplayNameName to be displayed with the review.string
allowUserNameWhether user agrees to display his name next to review."true" or "false"
Default: false
statusDefine 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:
 

ElementDescriptionValue
TagsAndReviewsRoot element of the XML tree.no value
errorThis 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>