Ready to Learn?Ex Libris products all provide open APIs

Get Tags

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

Input Parameters

ElementDescriptionValueMandatory
userIdUser ID.stringYes
docIdRecord id from the PNX table.stringYes

Output Parameters

ElementDescriptionValue
TagsAndReviewsRoot element of the XML tree.no value
TagsElement to contain one or several sub-elements.
Structure: Sub-element of TagsAndReviews.
no value
MyTagsElement to contain one or several sub-elements.
Structure: Sub-element of Tags.
no value
TagElement to contain one or several sub-elements.
Structure: Sub-element of MyTags.
no value
userIdUser id.
Structure: Sub-element of Tag.
string
docIdRecord id from the PNX table.
Structure: Sub-element of Tag.
string
statusStatus of tag (0=deleted ,2= Active) .
Structure: Sub-element of Tag.
"1" to "n"
valueThe tag name given by the user.
Structure: Sub-element of Tag.
string
EverybodyTagsElement to contain one or several sub-elements.
Structure: Sub-element of Tags.
no value
TagElement to contain one or several sub-elements.
Structure: Sub-element of EverybodyTags.
no value
userIdUser id.
Structure: Sub-element of Tag.
string
docIdRecord id from the PNX table.
Structure: Sub-element of Tag.
string
statusStatus of tag (0=deleted ,2= Active) .
Structure: Sub-element of Tag.
"1" to "n"
valueThe 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>