getTagsRequest

Ex Libris Developer Network Primo Documentation Primo REST APIs Web Services – Legacy SOAP (Web Services) Tags getTagsRequest

General Purpose

Provides the Tags of a specific Item

WSDL

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

Input Parameters

Element	Description	Value	Structure
getTagsRequest	Root element of the XML tree	no value	root element
userId	user id	string	sub-element of getTagsRequest
docId	record id from the PNX table	string	sub-element of getTagsRequest

Output Parameters

Element	Description	Value	Structure
TagsAndReviews	Root element of the XML tree	no value	root element
Tags	Element to contain one or several sub-elements (see structure)	no value	sub-element of TagsAndReviews
MyTags	Element to contain one or several sub-elements (see structure)	no value	sub-element of Tags
Tag	Element to contain one or several sub-elements (see structure)	no value	sub-element of MyTags
userId	user id	string	sub-element of Tag
docId	record id from the PNX table	string	sub-element of Tag
status	status of tag (0=deleted ,2= Active)	“1” to “n”	sub-element of Tag
value	the tag name given by the user	string	sub-element of Tag
EverybodyTags	Element to contain one or several sub-elements (see structure)	no value	sub-element of Tags
Tag	Element to contain one or several sub-elements (see structure)	no value	sub-element of EverybodyTags
userId	user id	string	sub-element of Tag
docId	record id from the PNX table	string	sub-element of Tag
status	status of tag (0=deleted ,2= Active)	“1” to “n”	sub-element of Tag
value	the tag name given by the user	string	sub-element of Tag

Input Example

<getTagsForRecordRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest" xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents">
  <docId>demo_voyager968394</docId>
  <userId>ohad</userId>
</getTagsForRecordRequest>

Output Example

<TagsAndReviews xmlns=">
  <Tags>
    <MyTags>
      <Tag>
        <value>demotag1</value>
        <docId>demo_voyager968394</docId>
        <userId>demo</userId>
        <status>2</status>
      </Tag>
    </MyTags>
    <EverybodyTags>
      <Tag>
        <value>ohadtag1</value>
        <docId>demo_voyager968394</docId>
        <userId>OHAD</userId>
        <status>2</status>
      </Tag>
      <Tag>
        <value>demotag1</value>
        <docId>demo_voyager968394</docId>
        <userId>demo</userId>
        <status>2</status>
      </Tag>
    </EverybodyTags>
  </Tags>
</TagsAndReviews>