The API enables the following interactions with results:
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
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
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
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
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
JSON Input
{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
id:3
}
JSON Output
Successfully deleted result [id].