/createcase

V1.0

Description

Creates a case in iCasework. Type is a mandatory field, and the other parameters below can alter aspects of the created case. In addition to the parameters described below, this API can be extended by the inclusion of fields on the form to be actioned, customer/agent attributes (of the same form as those used for /updatecustomer, prefixed with either "Customer." or "Agent.") , and action attributes. Please consult iCasework support for the correct notation for these fields.

Request Method

POST

API Service endpoints

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

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?
Type	The form synonym or form ID for the case type you wish to create	"Complaint"	Yes.
ExternalId	An external identifier for the created case	"abc12345"	No.
ExternalAccountId	Your reference for the account this case relates to, if any.	"12351"	No.
ExternalAccountType	The type of account this case relates to if any	"CTAX"	No.
RequestMethod	The contact method this case came in through	"Email"	No.
RequestDate	The date and time this case received (if different from the current time)	"1980-03-23T10:20:15"	No.
RequestId	Used to specify an iCasework case id, should you not wish to use our automatically generated internal identifiers	"142561"	No.
Customer.Id	The unique identifier of the customer to which this case relates	"125123"	No.
Agent.Id	The unique identifier of the representative for the customer	"7457625"	No.
Label	A label used to identify the case	"Complaint - Housing"	No.
Status	Used to define a custom starting status for the case.	"New case"	No.
Format	Defines the format of the API response. Default is "xml"	"xml" or "json"	No.

Example

Request

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

<?xml version="1.0" encoding="UTF-8" ?>
<Type>Complaint</Type>
<ExternalId>abc12345</ExternalId>
<ExternalAccountId>12351</ExternalAccountId>
<ExternalAccountType>CTAX</ExternalAccountType>
<RequestMethod>Email</RequestMethod>
<RequestDate>2021-03-23T10:20:15</RequestDate>
<RequestId>142561</RequestId>
<Customer.Id>125123</Customer.Id>
<Agent.Id>7457625</Agent.Id>
<Label>Complaint - Housing</Label>
<Status>New case</Status>

{
 "Type": "Complaint",
 "ExternalId": "abc12345",
 "ExternalAccountId": "12351",
 "ExternalAccountType": "CTAX",
 "RequestMethod": "Email",
 "RequestDate": "2021-03-23T10:20:15",
 "RequestId": "142561",
 "Customer.Id": "125123",
 "Agent.Id": "7457625",
 "Label": "Complaint - Housing",
 "Status": "New case",
 "Format": "json",
}

Response

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<createcaseresponse>
 <caseid>12345</caseid>
</createcaseresponse>

{"createcaseresponse":
  {
   "caseid": "12345"
  }
}

HTTP 400 responses

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

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
1000	Invalid HTTP method	Check the HTTP method of the request; this should be a POST
1001	Parameter Type is required	Specify a value for `Type`
1050	Another case already exists for reference `RequestId`	Specify a different case id for `RequestId` , or don’t include this parameter in the call so that an appropriate value is automatically assigned
1099	Various	Check the `X-Application-Error-Info` response header for tips; raise a support request with the helpdesk if you need any further clarification

HTTP 403 responses

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

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
1021	Incorrect key or signature	Check the authentication method of the request
1021	Invalid token (6)	Check the authentication method of the request
1022	Insufficient privileges for updating customer details	Check that there is a user associated with the API key

createcase