API: Programs

How to work with Programs through the Clear Impact Scorecard API.

Explanation of Program Parameters

• primaryTag[string] - String between 1-15 characters. This is the Clear Impact Scorecard tag used for categorizing this object. You can enter a tag that already exists to be linked or enter a new tag that does not exist and it will be created.
• title [string]* - The name of the Program
• scorecardID [int] (optional - parent value) - When retrieving a list of Programs you can pass in the ID of a Scorecard to retrieve just a list of Programs that are related to that Scorecard.

Get list of Programs

URL

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

XML Input

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

XML Output

<ArrayOfProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Program>
        <createDate>2013-10-11T00:00:00</createDate>
        <createdBy>email@domain.org</createdBy>
        <ID>1</ID>
        <modifiedBy>email@domain.org</modifiedBy>
        <modifyDate>2013-10-13T00:00:00</modifyDate>
        <title>New Program</title>
        <primaryTag>ThisIsATag</primaryTag>
    </Program>
    <Program>
        <createDate>2013-11-14T22:51:46.89</createDate>
        <createdBy>email@domain.org</createdBy>
        <ID>2</ID>
        <modifiedBy>email@domain.org</modifiedBy>
        <modifyDate>2013-11-14T22:51:46.89</modifyDate>
        <title>Newer Program</title>
        <primaryTag>ThisIsATag</primaryTag>
    </Program>
</ArrayOfProgram>

JSON Input

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

JSON Output

[
  {
    "ID": 1,
    "title": "New Program",
    "primaryTag": "ThisIsATag",
    "createDate": "2013-10-11T00:00:00",
    "createdBy": "email@domain.org",
    "modifyDate": "2013-10-13T00:00:00",
    "modifiedBy": "email@domain.org"
  },
  {
    "ID": 2,
    "title": "Newer Program",
    "primaryTag": "ThisIsATag",
    "createDate": "2013-11-14T22:51:46.89",
    "createdBy": "email@domain.org",
    "modifyDate": "2013-11-14T22:51:46.89",
    "modifiedBy": "email@domain.org"
  }
]

Add a Program

URL

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

XML Input

<Program>
    <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
    <siteCode>abc</siteCode>
    <primaryTag>ThisIsATag</primaryTag>
    <title>Newer Program</title>
</Program>

XML Output

<Program xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <createDate>2013-11-14T22:54:46.9527272-08:00</createDate>
    <createdBy>email@domain.org</createdBy>
    <ID>4</ID>
    <modifiedBy>email@domain.org</modifiedBy>
    <modifyDate>2013-11-14T22:54:46.9527272-08:00</modifyDate>
    <title>Newer Program</title>
    <primaryTag>ThisIsATag</primaryTag>
</Program>

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  "primaryTag": "ThisIsATag",
  "title":"New Program"
}

JSON Output

{
  "ID": 5,
  "title": "New Program",
  "primaryTag": "ThisIsATag",
  "createDate": "2013-11-14T22:59:57.0464828-08:00",
  "createdBy": "email@domain.org",
  "modifyDate": "2013-11-14T22:59:57.0464828-08:00",
  "modifiedBy": "email@domain.org"
}

Get Program Details

URL

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

XML Input

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

XML Output

<Program xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <createDate>2013-11-14T22:51:46.89</createDate>
    <createdBy>email@domain.org</createdBy>
    <ID>2</ID>
    <modifiedBy>email@domain.org</modifiedBy>
    <modifyDate>2013-11-14T22:51:46.89</modifyDate>
    <title>Newer Program</title>
    <primaryTag>ThisIsATag</primaryTag>
</Program>

JSON Input

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

JSON Output

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

Update a Program

URL

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

XML Input

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

XML Output

<Program xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <createDate>2013-11-14T22:51:46.89</createDate>
    <createdBy>email@domain.org</createdBy>
    <ID>2</ID>
    <modifiedBy>email@domain.org</modifiedBy>
    <modifyDate>2013-11-14T23:09:32.2339892-08:00</modifyDate>
    <primaryTag>ThisIsATag</primaryTag>
    <title>Updated Program</title>
</Program>

JSON Input

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

JSON Output

{
  "ID": 1,
  "title": "Updated Program",
  "primaryTag": "ThisIsATag",
  "createDate": "2013-10-11T00:00:00",
  "createdBy": "email@domain.org",
  "modifyDate": "2013-11-14T23:11:48.8589873-08:00",
  "modifiedBy": "email@domain.org"
}

Delete a Program

URL

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

XML Input

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

XML Output

Successfully deleted program [id].

JSON Input

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

JSON Output

Successfully deleted program [id].