Back to home

Help Center

Scorecard Documentation

API: Containers

The API enables the following interactions with containers:

Update a container
Add a container
Get container details
Update a container
Delete a container

Container Parameter Definitions

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]* - Container name
containerType [string]* - Measure type; lowercase is preferred. Available measure types for your instance can be found in Object Types.
scorecardID [int] (optional - parent value) - When retrieving a list of containers, including a scorecard ID narrows the list of containers to only those related to that scorecard. This parameter can also be used to link a new container to a scorecard, and will be placed in the last sort position on that scorecard.

Get list of Containers

URL

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

XML Input

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

XML Output

<ArrayOfContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Container>
        <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 Container</title>
        <containerType>Result</containerType>
        <primaryTag>ThisIsATag</primaryTag>
    </Container>
    <Container>
        <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 Container</title>
        <containerType>Result</containerType>
        <primaryTag>ThisIsATag</primaryTag>
    </Container>
</ArrayOfContainer>

JSON Input

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

JSON Output

[
  {
    "ID": 1,
    "title": "New Container",
    "containerType": "Result",
    "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 Container",
    "containerType": "Result",
    "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 Container

URL

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

XML Input

<Container>
    <apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
    <siteCode>abc</siteCode>
    <primaryTag>ThisIsATag</primaryTag>
    <title>Newer Container</title>
    <containerType>Result</containerType>
</Container>

XML Output

<Container 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 Container</title>
    <containerType>Result</containerType>
    <primaryTag>ThisIsATag</primaryTag>
</Container>

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  "primaryTag": "ThisIsATag",
  "title":"New Container",
  "containerType": "Result",
  "scorecardID": "8392"
}

JSON Output

{
  "ID": 5,
  "title": "New Container",
  "containerType": "Result",
  "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 Container Details

URL

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

XML Input

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

XML Output

<Container 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 Container</title>
    <containerType>Result</containerType>
    <primaryTag>ThisIsATag</primaryTag>
</Container>

JSON Input

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

JSON Output

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

Update a Container

URL

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

XML Input

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

XML Output

<Containerxmlns: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 Container</title>
    <containerType>Result</containerType>
</Container>

JSON Input

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

JSON Output

{
  "ID": 1,
  "title": "Updated Container",
  "containerType": "Result",
  "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 Container

URL

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

XML Input

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

XML Output

Successfully deleted Container [id].

JSON Input

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

JSON Output

Successfully deleted Container [id].