API: Results

The API enables the following interactions with results:

• Get list of results
• Add a result
• Get result details
• Update a result
• Delete a result

Explanation of Result Parameters

• primaryTag[string] - The tag used for categorizing this object, between 1-15 characters. You can enter a tag that already exists, or enter a new tag and it will be created.
• title [string]* - Result name
• scorecardID [int] (optional - parent value) - When retrieving a list of results, including a scorecard ID narrows the list of results to only those related to that scorecard.

Get List of Results

URL

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

XML Input

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

XML Output

<ArrayOfResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Result>
        <createDate>2013-10-11T00:00:00</createDate>
        <createdBy>email@domain.org</createdBy>
        <ID>1</ID>
        <modifiedBy>email@domain.org</modifiedBy>
        <modifyDate>2013-10-12T00:00:00</modifyDate>
        <title>New Result</title>
        <primaryTag>ThisIsATag</primaryTag>
    </Result>
    <Result>
        <createDate>2013-10-11T00:00:00</createDate>
        <createdBy>email@domain.org</createdBy>
        <ID>2</ID>
        <modifiedBy>email@domain.org</modifiedBy>
        <modifyDate>2013-10-12T00:00:00</modifyDate>
        <title>Another result</title>
        <primaryTag>ThisIsATag</primaryTag>
    </Result>
</ArrayOfResult>

JSON Input

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

JSON Output

[
  {
    "ID": 1,
    "title": "New Result",
    "primaryTag": "ThisIsATag",
    "createDate": "2013-10-11T00:00:00",
    "createdBy": "email@domain.org",
    "modifyDate": "2013-10-12T00:00:00",
    "modifiedBy": "email@domain.org"
  },
  {
    "ID": 2,
    "title": "Another result",
    "primaryTag": "ThisIsATag",
    "createDate": "2013-10-11T00:00:00",
    "createdBy": "email@domain.org",
    "modifyDate": "2013-10-12T00:00:00",
    "modifiedBy": "email@domain.org"
  }
]

Add a Result

URL

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

XML Input

<Result>
    <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
    <siteCode>abc</siteCode>
    <primaryTag>ThisIsATag</primaryTag>
    <title>New Result</title>
</Result>

XML Output

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <createDate>2013-11-15T10:47:33.5308972-08:00</createDate>
    <createdBy>email@domain.org</createdBy>
    <ID>3</ID>
    <modifiedBy>email@domain.org</modifiedBy>
    <modifyDate>2013-11-15T10:47:33.5308972-08:00</modifyDate>
    <title>New Result</title>
    <primaryTag>ThisIsATag</primaryTag>
</Result>

JSON Input

{
  "siteCode": "abc",
  "apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  "title": "Newer Result",
  "primaryTag": "ThisIsATag"
}

JSON Output

{
  "ID": 8,
  "title": "Newer Result",
  "primaryTag": "ThisIsATag",
  "createDate": "2013-11-15T10:55:09.6246348-08:00",
  "createdBy": "email@domain.org",
  "modifyDate": "2013-11-15T10:55:09.6246348-08:00",
  "modifiedBy": "email@domain.org"
}

Get Result Details

URL

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

XML Input

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

XML Output

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <createDate>2013-10-11T00:00:00</createDate>
    <createdBy>email@domain.org</createdBy>
    <ID>2</ID>
    <modifiedBy>email@domain.org</modifiedBy>
    <modifyDate>2013-10-12T00:00:00</modifyDate>
    <title>Another result</title>
    <primaryTag>ThisIsATag</primaryTag>
</Result>

JSON Input

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

JSON Output

{
  "ID": 1,
  "title": "New Result",
  "primaryTag": "ThisIsATag",
  "createDate": "2013-10-11T00:00:00",
  "createdBy": "email@domain.org",
  "modifyDate": "2013-10-12T00:00:00",
  "modifiedBy": "email@domain.org"
}

Update a Result

URL

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

XML Input

<Result>
    <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
    <siteCode>abc</siteCode>
    <ID>2</ID>
    <primaryTag>ThisIsATag</primaryTag>
    <title>Updated result</title>
</Result>

XML Output

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <createDate>2013-10-11T00:00:00</createDate>
    <createdBy>email@domain.org</createdBy>
    <ID>2</ID>
    <modifiedBy>email@domain.org</modifiedBy>
    <modifyDate>2013-11-15T10:58:48.3746017-08:00</modifyDate>
    <title>Updated result</title>
    <primaryTag>ThisIsATag</primaryTag>
</Result>

JSON Input

{
  "siteCode": "abc",
  "apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  "ID": 1,
  "primaryTag": "ThisIsATag",
  "title": "Updated Result"
}

JSON Output

{
  "ID": 1,
  "title": "Updated Result",
  "primaryTag": "ThisIsATag",
  "createDate": "2013-10-11T00:00:00",
  "createdBy": "email@domain.org",
  "modifyDate": "2013-11-15T11:03:31.2339741-08:00",
  "modifiedBy": "email@domain.org"
}

Delete a Result

URL

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

XML Input

<Result>
    <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
    <siteCode>abc</siteCode>
    <ID>2</ID>
</Result>

XML Output

Successfully deleted result [id].

JSON Input

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

JSON Output

Successfully deleted result [id].