Assessments
This article documents how to perform actions via the API relating to assessments. Ensure that the appropriate authentication headers are configured when sending these requests.
Service location
The endpoint you need to use is based on which environment is hosting your PACE system. You can find this out by checking your normal login link. Make your selection below and all examples will be tailored to your environment.
Schema
Assessment records will be returned in the following format
{
"FullName": string,
"UserId": string,
"UserGuid": Guid,
"IsLocked": boolean,
"UserStatus": string, // Active | Archived | Suspended | Long term absent
"AssessmentName": string,
"AssessmentStatus": string, // Active | Archived
"ParentOrganisation": string,
"Organisation": string,
"ProgrammeName": string,
"CompletedDate": nullable DateTime, // yyyy-MM-ddTHH:mm:ss.SSS e.g. "2022-03-24T09:15:42.753"
"CreatedDate": DateTime, // yyyy-MM-ddTHH:mm:ss.SSS e.g. "2022-03-24T09:15:42.753"
"Progress": string,
"Risk": nullable decimal,
"ProgressionStatus": string
}
Retrieve all assessments
get api/assessments
This action will return all assessment instances within your PACE Administration system. This action also supports the Pagination of records functionality.
Example request
Send a GET request to https://online.cardinus.com/api/Assessments. This will produce a result object containing a
summary of the data and a collection of user instances from the database.
Example response
{
"PageNumber": 1,
"PageSize": 100,
"FirstPage": "https://online.cardinus.com/api/Assessments?pageNumber=1&pageSize=2",
"LastPage": "https://online.cardinus.com/api/Assessments?pageNumber=2322&pageSize=2",
"TotalPages": 47,
"TotalRecords": 4644,
"NextPage": "https://online.cardinus.com/api/Assessments?pageNumber=2&pageSize=2",
"PreviousPage": null,
"ItemsCount": 100,
"Items": [
{
"FullName": "Brad Storch",
"UserId": "bstorch",
"UserGuid": "65467435-7ae9-e211-a494-00155d145c00",
"IsLocked": false,
"UserStatus": "Active",
"AssessmentName": "Healthy Working Plus - Profile",
"AssessmentStatus": "Archived",
"ParentOrganisation": "N/A",
"Organisation": "Example Organisation",
"ProgrammeName": "Healthy Working Plus",
"CompletedDate": "2022-03-24T09:15:42.753",
"CreatedDate": "2022-03-24T09:15:42.753",
"Progress": "Finished",
"Risk": 0,
"ProgressionStatus": null
},
{
"FullName": "Brad Storch",
"UserId": "bstorch",
"UserGuid": "65467435-7ae9-e211-a494-00155d145c00",
"IsLocked": false,
"UserStatus": "Active",
"AssessmentName": "Healthy Working Plus",
"AssessmentStatus": "Archived",
"ParentOrganisation": "N/A",
"Organisation": "Example Organisation",
"ProgrammeName": "Healthy Working Plus",
"CompletedDate": "2022-03-24T09:21:19.78",
"CreatedDate": "2022-03-24T09:21:19.78",
"Progress": "Finished",
"Risk": 10,
"ProgressionStatus": null
},
etc...
],
"Succeeded": true,
"Errors": null,
"Message": null
}
Retrieve assessments by user
get api/assessments/{userid}
This action will return assessments created for a specific user via the parameter passed in on the request. The parameter is the user's unique identifier in a GUID format.
| Parameter | Description | Location |
|---|---|---|
userid |
User ID in a GUID format | URL |
Example request
Send a GET request to https://online.cardinus.com/api/Assessments/{userid}. The resulting data will be a collection
of assessments restricted to the given user.
Example response
{
"Count": 6,
"Items": [
{
"FullName": "Brad Storch",
"UserId": "bstorch",
"UserGuid": "65467435-7ae9-e211-a494-00155d145c00",
"IsLocked": false,
"UserStatus": "Active",
"AssessmentName": "Healthy Working Plus - Profile",
"AssessmentStatus": "Archived",
"ParentOrganisation": "N/A",
"Organisation": "Example Organisation",
"ProgrammeName": "Healthy Working Plus",
"CompletedDate": "2022-03-24T09:15:42.753",
"CreatedDate": "2022-03-24T09:15:42.753",
"Progress": "Finished",
"Risk": 0,
"ProgressionStatus": null
},
{
"FullName": "Brad Storch",
"UserId": "bstorch",
"UserGuid": "65467435-7ae9-e211-a494-00155d145c00",
"IsLocked": false,
"UserStatus": "Active",
"AssessmentName": "Healthy Working Plus",
"AssessmentStatus": "Archived",
"ParentOrganisation": "N/A",
"Organisation": "Example Organisation",
"ProgrammeName": "Healthy Working Plus",
"CompletedDate": "2022-03-24T09:21:19.78",
"CreatedDate": "2022-03-24T09:21:19.78",
"Progress": "Finished",
"Risk": 10,
"ProgressionStatus": null
},
etc...
]
}
Filter assessments
post api/assessments/filter
This action will retrieve all assessments depending on the parameters passed in the body. The body is in JSON format and providing no parameters will default to all assessments.
| Parameter | Description | Location |
|---|---|---|
| assessment details | The filtering query options to restrict the result set | Request body |
Important
The content-type header must be included and set to application/json.
Example request
Send a POST request to https://online.cardinus.com/api/Assessments/Filter with search criteria in the body as specified below. The
response will contain filtered results. Each property is applied using the AND logical operator.
The JSON schema including all the properties that can be used to filter data:
{
"UserId": string,
"Islocked": boolean,
"UserStatus": string,
"AssessmentName": string,
"AssessmentStatus": string,
"AssessmentsCompletedYesterday": boolean,
"OnOrBeforeDate": DateTime, // yyyy-MM-dd e.g. "2024-01-01"
"OnOrAfterDate": DateTime, // yyyy-MM-dd e.g. "2024-01-01"
"ParentOrganisation": string,
"Organisation": string,
"ProgrammeName": string
}
For example, to retrieve only assessments associated with archived users you can use this filter:
{
"UserStatus": "archived"
}
Example response
{
"PageNumber": 1,
"PageSize": 100,
"FirstPage": "https://online.cardinus.com/api/Assessments/Filter?pageNumber=1&pageSize=100",
"LastPage": "https://online.cardinus.com/api/Assessments/Filter?pageNumber=6&pageSize=100",
"TotalPages": 6,
"TotalRecords": 516,
"NextPage": "https://online.cardinus.com/api/Assessments/Filter?pageNumber=2&pageSize=100",
"PreviousPage": null,
"ItemsCount": 100,
"Items": [
{
"FullName": "Brad Storch",
"UserId": "bstorch",
"UserGuid": "73464643-a85d-ec11-811a-005056b147ee",
"IsLocked": false,
"UserStatus": "Archived",
"AssessmentName": "Healthy Working Plus - Profile",
"AssessmentStatus": "Active",
"ParentOrganisation": "Scotland",
"Organisation": "Scotland Services",
"ProgrammeName": "Healthy Working Plus",
"CompletedDate": "2022-09-30T08:39:50.067",
"CreatedDate": "2022-09-30T08:39:50.067",
"Progress": "Finished",
"Risk": 0,
"ProgressionStatus": "Healthy Working Plus - Profile"
},
{
"FullName": "Betty Symington",
"UserId": "bsymington",
"UserGuid": "85475745-a85d-ec11-811a-005056b147ee",
"IsLocked": false,
"UserStatus": "Archived",
"AssessmentName": "Healthy Working Plus",
"AssessmentStatus": "Active",
"ParentOrganisation": "Northern Ireland",
"Organisation": "Management (NI)",
"ProgrammeName": "Healthy Working Plus",
"CompletedDate": "2022-09-30T09:26:41.457",
"CreatedDate": "2022-09-30T09:26:41.457",
"Progress": "Finished",
"Risk": 0,
"ProgressionStatus": "Completed / No Risk"
},
...
],
"Succeeded": true,
"Errors": null,
"Message": null
}
Retrieve an overview of all assessments
get api/assessments/overview
This action will give an overview of relevant data for all assessments in the PACE Administration system.
Example request
Send a GET request to https://online.cardinus.com/api/assessments/overview with no parameters to get the overview of assessment
data in your PACE system.
Example response
{
"Count": 2920
}