/createauditentry

V1.0

Description

Creates an entry in the audit trail for a specific iCasework case

Name is the only required parameter. Other parameters are optional and will alter the appearance of the created audit entry.

Request Method

POST

API Service endpoints

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

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?
Name	The title of the audit entry.	"Case updated"	Yes.
Details	The details for the audit entry.	"Customer name changed to Jones"	No.
By	The source for the audit entry.	"Thomas Thorpe"	No.
ExcludeRepeats	If true, subsequent transactions with the same details will not be logged again within the same hour.	"true" or "false"	No.
CustomerId	The customer identifier which to apply the audit entry against.	"154121"	No.
CaseId	The internal identifier for the case to which to apply the audit entry.	"2352762"	No.
ExternalId	The external identifier for the case to which to apply the audit entry.	"2627211"	No.
Format	Defines the format of the API response. Default is "xml"	"xml" or "json"	No.

Example

Request

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

<?xml version="1.0" encoding="UTF-8" ?>
<Name>Case updated</Name>
<Details>Customer name changed to Jones</Details>
<By>John Smith</By>
<ExcludeRepeats>true</ExcludeRepeats>
<CaseId>145123</CaseId>

{
 "Name": "Case updated",
 "Details":"Customer name changed to Jones",
 "By":"John Smith",
 "ExcludeRepeats": true,
 "CaseId":"145123".
 "Format":"json"
}

Response

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<createauditentryresponse>
 <id>12345</id>
</createauditentryresponse>

{"createauditentryresponse":
  {
   "id": "12345"
  }
}

HTTP 400 responses

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

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
97000	Invalid HTTP Method	Check the HTTP method; this should be a POST
97001	API not available here	Check the endpoint of the request
97002	Parameter Name is required	Specify a `Name` in the request
97003	Case not found	Check the value for `CaseId` is valid; if `CaseId` is not specified then ensure that the value for `ExternalId` is valid
97004	Customer not found	Check that the value for `CustomerId` is valid
97099	Unexpected error	Please raise a support request with the helpdesk. Provide the time/date the call was made and when this call was last working as expected; the URL of the request, including details about parameters and payload; details of the API Key used for authentication

HTTP 403 responses

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

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
97021	Incorrect key or signature	Check the authentication method of the request
97021	Invalid token (6)	Check the authentication method of the request
97022	Insufficient privileges for updating customer details	Check that there is a user associated with the API key
97023	Insufficient privileges to update audit trail	Check that the user associated with the API key has sufficient access to update the audit trail of that case; where the case can be identified using the `CaseId` and/or `ExternalId` parameters if the parameter is not null

createauditentry