Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update case note documentation #377

Merged
merged 1 commit into from
Feb 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -842,6 +842,57 @@ components:
caseNoteId:
type: string
example: 1234
offenderIdentifier:
type: string
example: : A1234AA
type:
type: string
example: KA
typeDescription:
type: string
example: Key Worker
subType:
type: string
example: KS
subTypeDescription:
type: string
example: Key Worker Session
CreatDateTime:
type: string
format: date
example: 2023-09-05T10:15:41
description: Date and Time of Case Note creation
occurrenceDateTime:
type: string
format: date
example: 2023-09-05T10:15:41
description: Date and Time of when case note contact with offender was made
text:
type: string
example: This is some text
locationId:
type: string
example: MDI
amendments:
type: array
minItems: 0
items:
$ref: "#/components/schemas/CaseNoteAmendment"
description: List of amendments to the case note
CaseNoteAmendment:
type: object
properties:
caseNoteAmendmentId:
type: integer
format: int64
creationDateTime:
type: string
format: date
example: 2023-09-05T10:15:41
description: Date and Time of Case Note creation
addtionalNoteText:
type: string
example: Some Additional Text
CaseSentence:
required:
- date
Expand Down
Loading