Get Tags

Ex Libris Developer Network Primo Documentation Primo REST APIs Web Services – Legacy X-Services Tags Get Tags

General Purpose

The tags/get request returns the tags for a specific item.

Input Parameters

Element	Description	Value	Mandatory
userId	User ID.	string	Yes
docId	Record id from the PNX table.	string	Yes

Output Parameters

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

Input Example

http://primo:170X/PrimoWebServices/xservice/tags/get?userId=demo&docId=demo_voyager968394

Output Example

<TagsAndReviews xmlns="http://com/exlibris/primo/xsd/tagsAndReview/config">
  <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>