Operations

The various types of operations available are documented below.

Client Create

Create a client record.
Operation type identifier: ClientCreate

Data Structure

Property	Data type	Required	Description
types	array of client type references	Dependent on configuration	The client types to assign to the client.
title	string (enum)	Dependent on configuration	The client’s title (from their name).
firstName	string	Dependent on configuration	Their first name.
middleNames	string	Dependent on configuration	Their middle names (if the system is configured to use middle names).
lastName	string	Dependent on configuration	Their last name.
dateOfBirth	date	Dependent on configuration	Their date of birth.
telephone	string	Dependent on configuration	Their primary telephone number.
mobileTelephone	string	Dependent on configuration	Their mobile telephone number.
secondaryTelephone	string	Dependent on configuration	Their secondary telephone number.
fax	string	No	Their fax number.
email	string	Dependent on configuration	Their email address.
address	address	Dependent on configuration	Their address.
gender	string (enum)	Dependent on configuration	Their gender.
flags	array of string (enums)	No	Their flags.
fieldValues	fieldValues	Dependent on configuration	Their field values.
contactConsent	object with optional keys (email | sms), values: string (YES | NO | NOT_ASKED)	No	Their contact consent for different communication methods.

Case Create

Create a case record.

Operation type identifier: CaseCreate

Data Structure

Property	Data type	Required	Description
summary	string	No	A summary of the case.
description	string	No	A description of the case.
type	case type reference	Yes	A reference to the case type.
client	client reference	Dependent on configuration	A reference to the client.
openDate	date	Yes	The date the case was opened.
contactChannel	contact channel reference	Yes	A reference to the contact channel used.
owner	caseworker reference	No	A reference to the caseworker owning the case.
fieldValues	field values	Dependent on configuration	The field values.

Case Action Create

Create a case action record.

Operation type identifier: CaseActionCreate

Data Structure

Property	Data type	Required	Description
case	case reference	Yes	A reference to the case this action is for.
type	case type reference	Yes	A reference to the type of case action.
date	date	No	The date the action was taken (defaults to current date if not supplied).
dueDate	date	No	The date the action is due.
assignee	caseworker reference	Dependent on configuration	A reference to the caseworker to assign the action to.
assigneeTeam	team reference	Dependent on configuration	A reference to the team to assign the action to.
summary	string	No	A summary of the action.
details	string	No	Details of the action.
fieldValues	fieldValues	Dependent on configuration	The field values.

Case Action Add Attachment

Add a file attachment to a case action. Note that a case action is required for adding attachments; a suitable action type will be configured, and it’s ID supplied separately.

Operation type identifier: CaseActionAddAttachment

Data Structure

Property	Data type	Required	Description
caseAction	case action reference	Yes	A reference to the case action to add the attachment to.
file	an object with two properties: name {string} - the file name data {string} - the base-64 (UTF-8) encoded data	Yes	The file attachment.