API: Tags

The API enables the following interactions with tags:

• Get list of tags
• Add a tag
• Get tag details
• Update a tag
• Delete a tag

Note: Tags can also be created through the API when creating or updating results and programs, indicators and performance measures, or actions, via the "primaryTag" parameter.

Explanation of Tag Parameters

• description [string]* - Tag description (150 characters maximum)
• name [string]* - Tag name (15 characters maximum)

Get List of Tags

URL

https://api.resultsscorecard.com/api/tags/list

XML Input

<?xml version="1.0"?>
<Parameters>
  <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
  <siteCode>abc</siteCode>
</Parameters>

XML Output

<?xml version="1.0"?>
<ArrayOfTag xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Tag>
    <description>Tag1</description>
    <ID>2</ID>
    <name>Tag1</name>
</Tag>
<Tag>
    <description>tag_description</description>
    <ID>5</ID>
    <name>tag_name</name>
</Tag>
</ArrayOfTag>

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO"
}

JSON Output

[
  {
    "ID": 2,
    "name": "Tag1",
    "description": "Desc of Tag1"
  },
  {
    "ID": 5,
    "name": "tag name",
    "description": "tag desc"
  },
  {
    "ID": 6,
    "name": "new tag",
    "description": "just another tag"
  }
]

Add a Tag

URL

https://api.resultsscorecard.com/api/tags/add

XML Input

<?xml version="1.0"?>
<Tag>
    <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
    <siteCode>abc</siteCode>
    <description>the tag description</description>
    <name>the tag name</name>
</Tag>

XML Output

<Tag xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <description>the tag description</description>
  <ID>16</ID>
  <name>the tag name</name>
</Tag>

JSON Input

{
 siteCode: "abc",
 apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
 description: "tag Desc",
 name: "tag Name"
}

JSON Output

{
"ID":1026,
"name":"tag Name",
"description":"tag Desc"
}

Get Tag Details

URL

https://api.resultsscorecard.com/api/tags/details

XML Input

<?xml version="1.0"?>
<Parameters>
  <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
  <siteCode>abc</siteCode>
  <ID>6</ID>
</Parameters>

XML Output

<Tag xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <description>just another tag</description>
    <ID>6</ID>
    <name>new tag</name>
</Tag>

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  id:2
}

JSON Output

{
  "ID":2,
  "name":"Tag1",
  "description":"Tag1"
}

Update a Tag

URL

https://api.resultsscorecard.com/api/tags/update

XML Input

<Tag>
    <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
    <siteCode>abc</siteCode>
    <description>updated desc</description>
    <ID>1027</ID>
    <name>updated name</name>
</Tag>

XML Output

<Tag xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <description>updated desc</description>
    <ID>1027</ID>
    <name>updated name</name>
</Tag>

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  id:16,
  name: "updated tag",
  description: "updated tag description"
}

JSON Output

{
  "ID":16,
  "name":"updated tag",
  "description":"updated tag description"
}

Delete a Tag

URL

https://api.resultsscorecard.com/api/tags/delete

XML Input

<?xml version="1.0"?>
<Tag>
   <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
   <siteCode>abc</siteCode>
   <ID>16</ID>
</Tag>

XML Output

Successfully deleted tag [id].

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  id:16
}

JSON Output

Successfully deleted tag [id].