/getcasecorrespondence

V1.0

Description

Gets a copy of a case correspondence in an HTML or PDF format, depending on whether the correspondence in question is an email or letter. Either a CaseId or ExternalId must be supplied, as well as an Id or Type.

Request Method

GET

API Service endpoints

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

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

Request Parameters

Parameter	Description	Values	Required value?

Parameter	Description	Values	Required value?
CaseId	The iCasework identifier to which the correspondence relates. An `ExternalId` or `CaseId` must be supplied.	"165161"	No.
ExternalId	The external identifier of the case to which the correspondence relates. An `ExternalId` or `CaseId` must be supplied.	"17581768"	No.
Type	The template code that relates to the template that was used to generate the correspondence you wish to get. If more than one correspondence was sent from a given case, the most recently processed will be returned. Your iCasework support representative can inform you of the values to use. An `Id` or `Type` must be supplied.	"ACKNOWLEDGEMENT"	No.
Id	The correspondence id for the piece of correspondence you wish to get. An `Id` or `Type` must be supplied. This can be obtained from correspondence reporting.	"1561561"	No.

Example

Request

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

{
 "CaseId": "151325125",
 "Type":"ACKNOWLEDGEMENT"
}

<?xml version="1.0" encoding="UTF-8" ?>
<CaseId>151325125</CaseId>
<Type>ACKNOWLEDGEMENT</Type>

Response

The correspondence in HTML/PDF.

HTTP 400 responses

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

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
29000	Invalid HTTP Method.	Check the HTTP method; this should be a GET
29001	API not available here.	Check the endpoint of the request
29002	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`
29002	Unable to identify correspondence item. Please provide a valid value for parameter Type or Id.	Check that a value has been passed for `Type` or `Id`
29003	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 `CaseId` has not been passed then check `ExternalId` is valid
29099	Various	Check the `X-Application-Error-Info` response 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
29021	Incorrect key or signature	Check the authentication method
29021	Invalid token (6)	Check the authentication method

getcasecorrespondence