/getcasedetails

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 full details about a given case. Either a CaseId or ExternalId must be provided. The exact details returned will depend on your configuration.

Request Method

GET

API Service endpoints

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

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 unique identifier for the case from which you want the details.	"1235165"	No.
ExternalId	The external identifier for the case from which you want the details.	"16717289"	No.
Format	Defines the format of the API response. Default is "xml"	"xml" or "json"	No.

Example

Request

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

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

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

Response

The details for the requested case

<?xml version="1.0" encoding="UTF-8"?>
<Cases RequestId="483010">
    <Case>
        <CaseDetails.TotalRedress></CaseDetails.TotalRedress>
        <CaseDetailsCompliment.Details>This API documentation is great</CaseDetailsCompliment.Details>
        <CaseDetailsCompliment.StaffMember>Support User</CaseDetailsCompliment.StaffMember>
        <CaseDetails.CaseId>483010</CaseDetails.CaseId>
        <CaseDetails.Reference></CaseDetails.Reference>
        <CaseDetails.ParentCaseId></CaseDetails.ParentCaseId>
        <CaseDetails.CaseType>Compliment</CaseDetails.CaseType>
        <CaseDetails.FormType>Compliment</CaseDetails.FormType>
        <CaseDetails.Rating></CaseDetails.Rating>
        <CaseDetails.Confidential>No</CaseDetails.Confidential>
        <CaseDetails.AssignedTo>Support User</CaseDetails.AssignedTo>
        <CaseDetails.AssignedToId>SUPPORT</CaseDetails.AssignedToId>
        <CaseDetails.Department></CaseDetails.Department>
        <CaseDetails.AssignedToJobTitle>Support Representative</CaseDetails.AssignedToJobTitle>
        <CaseDetails.AssignedToAddress>Kimberley Road
London NW6 7SG</CaseDetails.AssignedToAddress>
        <CaseDetails.Team>Resident Experience Team</CaseDetails.Team>
        <CaseDetails.TeamCode>HFINTOUCHTEAM</CaseDetails.TeamCode>
        <CaseDetails.Directorate>Adult social care</CaseDetails.Directorate>
        <CaseDetails.Service>Assessment and care coordination</CaseDetails.Service>
        <CaseDetails.PrimaryClassificationId></CaseDetails.PrimaryClassificationId>
        <CaseDetails.PrimaryClassificationIdId></CaseDetails.PrimaryClassificationIdId>
        <CaseDetails.PrimaryCause></CaseDetails.PrimaryCause>
        <CaseDetailsComplaint.TotalVindiciaRefund></CaseDetailsComplaint.TotalVindiciaRefund>
    </Case>
</Cases>

{
    "CaseDetails.TotalRedress": "",
    "CaseDetailsCompliment.Details": "This API documentation is great",
    "CaseDetailsCompliment.StaffMember": "Support User",
    "CaseDetails.CaseId": "483010",
    "CaseDetails.Reference": "",
    "CaseDetails.ParentCaseId": "",
    "CaseDetails.CaseType": "Compliment",
    "CaseDetails.FormType": "Compliment",
    "CaseDetails.Rating": "",
    "CaseDetails.Confidential": "No",
    "CaseDetails.AssignedTo": "Support User",
    "CaseDetails.AssignedToId": "SUPPORT",
    "CaseDetails.Department": "",
    "CaseDetails.AssignedToJobTitle": "Support Representative",
    "CaseDetails.AssignedToAddress": "Kimberley Road\r\nLondon NW6 7SG",
    "CaseDetails.Team": "Resident Experience Team",
    "CaseDetails.TeamCode": "HFINTOUCHTEAM",
    "CaseDetails.Directorate": "Adult social care",
    "CaseDetails.Service": "Assessment and care coordination",
    "CaseDetails.PrimaryClassificationId": "",
    "CaseDetails.PrimaryClassificationIdId": "",
    "CaseDetails.PrimaryCause": "",
    "CaseDetailsComplaint.TotalVindiciaRefund": "",
    "CaseDetailsComplaint.TotalRefundToCard": "",
    "CaseDetailsComplaint.TotalRefund": "",
    "CaseDetailsComplaint.TotalPaid": "",
    "CaseDetailsComplaint.TotalGoodwill": "",
    "CaseDetailsComplaint.TotalComp": "",
    "CaseDetailsComplaint.TotalCheque": "",
    "CaseDetails.TotalCompensation": "0.00",
    "CaseStatus.Status": "Awaiting action",
    "CaseStatus.CurrentTargetDate": "2022-09-22",
    "CaseStatus.CurrentTargetDays": "7",
    "CaseStatus.CurrentStage": "",
    "CaseStatus.CurrentOutcome": ""
}

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 or ExternalId.	Check that a valid value has been passed for `CaseId` ; if a value for `CaseId` has not been passed then check that the value for `ExternalId` is valid.
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

getcasedetails