How to work with Users through the Clear Impact Scorecard API.
User records accessed through the API are read only. All changes to user records must be conducted in the Clear Impact Scorecard software itself.
Parameters:
ID [int] - When retrieving the details for a specific user this is the ID of the user being requested.
Get list of Users for an Instance
URL
https://api.resultsscorecard.com/api/users/list
XML Input
<?xml version="1.0"?>
<Parameters>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
</Parameters>
XML Output
<ArrayOfUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<User>
<id>1</id>
<firstName>John</firstName>
<lastName>Doe</lastName>
<emailAddress>john@doe.com</emailAddress>
<isPrimaryContact>true</isPrimaryContact>
<isActive>false</isActive>
</User>
</ArrayOfUser>
JSON Input
{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO"
}
JSON Output
[
{
"id": 1,
"firstName": "John",
"lastName": "Doe",
"emailAddress": "john@doe.com",
"isPrimaryContact": false,
"isActive": true
}
]
Get User Details
URL
https://api.resultsscorecard.com/api/users/details
XML Input
<?xml version="1.0"?>
<Parameters>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<id>2</id>
</Parameters>
XML Output
<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<id>1</id>
<firstName>John</firstName>
<lastName>Doe</lastName>
<emailAddress>john@doe.com</emailAddress>
<isPrimaryContact>true</isPrimaryContact>
<isActive>false</isActive>
</User>
JSON Input
{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
id:1
}
JSON Output
{
"id": 1,
"firstName":"John",
"lastName":"Doe",
"emailAddress":"john@doe.com",
"isPrimaryContact":false,
"isActive":true
}