Toggle menu

addNoteToCase

Adds a note to a case. Notes can be added to open and closed cases.

Namespace

goss.CaseManagement.v1.api.notes.addNoteToCase

Worker

serverlibrary

Parameters

Required PropertiesTypeDescription
caseReferenceString <businessKey>The business key of the case
noteStringThe note you'd like to add
userNameStringThis user will be recorded as the user adding the note. You must make sure the user exists and has permission to add a note to the case
Optional PropertiesTypeDescription
nameStringThe display name of the user logging the note
privateBooleanDefault: false. Set true to log a private note (only visible to case managers)
userRoleStringThe role of the user logging the note (eg "staff" or "citizen")

Example

See Case Management API for a full example call.

{
    "note": "A test note from a member of staff",
    "private": true,
    "caseReference": "9473-1891-4484-7268",
    "name": "Test User",
    "userRole": "staff",
    "userName": "cmdemomanager"
}

Responses

Success

{
    "id": 123,
    "result": {
        "success": true
    },
    "jsonrpc": "2.0"
}

Error

{
    "id": 117,
    "result": {
        "success": false,
        "errors": ["Could not load case reference - 9473-1891-4484-7268"]
    },
    "jsonrpc": "2.0"
}

Last modified on 01 September 2022

Share this page

Facebook icon Twitter icon email icon

Print

print icon