getcasecontactdetails

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

Returns the details of any contacts (parties) that are present on a particular case, as specified in the CaseIdparameter. A valid CaseId must be specified.

Request Method

GET

API Service endpoints

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

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?
CaseId	The iCasework reference number for a specific case. HTTP 400 response if there is no case with a matching `CaseId`.	“142918”	Yes.
Format	The format of the response, can be either “xml” or “json”; the default format is XML.	“json”	No.

Example

Request

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

<?xml version="1.0" encoding="UTF-8" ?>
<CaseId>123456</CaseId>
<Format>xml</Format>

{
		"CaseId": "123456",
		"Format": "json"
}

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CaseContacts>
    <CaseContact>
        <fullName>Smith, Mr John</fullName>
        <email>john.smith@example.co.uk</email>
        <userId>218222</userId>
        <role>Contact</role>
    </CaseContact>
</CaseContacts>

{
	"CaseContacts": {
		"CaseContact": {
			"fullName": "Smith, Mr John",
			"email": "john.smith@example.co.uk",
			"userId": "218222",
			"role": "Contact"
		}
	}
}

HTTP 400 responses

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

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
2000	Invalid HTTP Method.	Check the HTTP method; this should be a GET
2001	API not available here.	Check the endpoint of the request
2002	Unable to identify case. Please provide a valid value for parameter CaseId or ExternalId.	Check that a value has been passed for `ExternalId` or `CaseId`
2003	Unable to identify case. Please provide a valid value for parameter CaseId.	Check that a valid value has been passed for `CaseId`
2099	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
2021	Incorrect key or signature	Check the authentication method
2021	Invalid token (6)	Check the authentication method
37022	User does not have case access permissions.	The API key you are using is assigned to a user that doesn’t have access to the case; or is not assigned to a user