getrecentcaselist

V1.0

Sensitive Data Warning

This API endpoint returns data which could include personally identifiable information (PII), such as names, contact details, or other data elements contained within the case details, classifications, or documents. PII is subject to strict data protection laws (e.g., GDPR, Data Protection Act 2018) and must be handled with the utmost care.

Description

Gets a list of recent cases, for a user with a username equal to the UserName field.

Request Method

GET

API Service endpoints

UAT: https://uat.icasework.com/getrecentcaselist?db=[youriCaseworkAccount]
eUAT / Production system: https://[youriCaseworkAccount].icasework.com/getrecentcaselist

Your iCasework account name will be supplied to you by your iCasework Account or Project Manager

Request Parameters

Parameter	Description	Example Input	Required value?

Parameter	Description	Example Input	Required value?
UserName	The username of the user, whose recent cases should be returned	"JOHN.SMITH"	Yes.
Format	The format of the response; the default is XML.	“json”	No.
Until	A date to represent

Example

Request

<https://example.icasework.com/getrecentcaselist>

<?xml version="1.0" encoding="UTF-8" ?>
<Username>JOHN.SMITH</Username>

[
    {
			"Username": "JOHN.SMITH"
    }
]

Response

<?xml version="1.0" encoding="UTF-8" ?>
<Cases>
        <cases>
            <caseId>480381</caseId>
            <displayLabel>Complaint 480381 Bloggs, Mr Fred</displayLabel>
            <dateReceived>2022-09-13</dateReceived>
            <status>New case</status>
        </cases>
</Cases>

[
    {
        "caseId": "451183",
        "displayLabel": "Complaint - Other service 451183 Jones, Mrs Test",
        "dateReceived": "2022-05-18",
        "status": "Upheld (Corporate stage 1) (closed)"
    }
]

HTTP 400 responses

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
43000	Invalid HTTP Method.	Check the HTTP method; this should be a GET
43001	API not available here	Check the endpoint of the request
43099	Various	Check the `X-Application-Error-Info` header for more information.

HTTP 403 responses

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
43021	Incorrect key or signature	Check the authentication method
43021	Invalid token (6)	Check the authentication method