Ready to Learn?Ex Libris products all provide open APIs

General Purpose

Adds a review to a specific item

WSDL

The WSDL file is located under the following URL:
<your address>:<fe_port>/PrimoWebServices/services/reviews?wsdl

Input Parameters

ElementDescriptionValueDefaultStructure
addReviewRequestRoot element of the XML treeno value root element
userIduser idstring sub-element of addReviewRequest
docIdrecord id from the PNX tablestring sub-element of addReviewRequest
valuethe user's review to be addedstring sub-element of addReviewRequest
ratingrate given by the user to the Item1 to 101sub-element of addReviewRequest
userDisplayNamename to be displayed with the reviewstring sub-element of addReviewRequest
allowUserNamewhether user agrees to display his name next to review"true" or "false"FALSEsub-element of addReviewRequest
statusDefine the status of the review. The valid value is 2.string sub-element of addReviewRequest

Output

No output

Example Input

<addReviewRequest xmlns=http://www.exlibris.com/primo/xsd/wsRequest\
        xmlns:uic=http://www.exlibris.com/primo/xsd/primoview/uicomponents\>
        <docId> demo_voyager968394</docId>
        <userId>demo</userId>
        <rating>4</rating>
        <value>good55</value>
        <userDisplayName>Hila</userDisplayName>
        <allowUserName>true</allowUserName>
        <status>2</status>
</addReviewRequest>
 

Example Output

<TagsAndReviews xmlns="http://com/exlibris/primo/xsd/tagsAndReview/config">
        <ERROR MESSEGE="Add review successfully" CODE="0"/>
</TagsAndReviews>