Merge pull request #352 from ministryofjustice/HIA-643

Golden record for adjudications endpoint

Author: chiaramapellimt

openapi.yml

@@ -195,7 +195,7 @@ paths:
         - persons
       summary: >
         Returns offences associated with a person.
-        
+
         Note: This API does not contain the complete list of offences for a person.
         Offences are retrieved from Prison and Probation systems exclusively.
         Prison systems record only custodial sentences, while Probation systems record only the main offence and some additional offences for case management purposes. Other offences recorded by HMCTS and police may not be included.
@@ -364,7 +364,7 @@ paths:
         - needs
       summary: >
         Returns criminogenic needs associated with a person.
-        
+
         Note: Criminogenic needs are dynamic factors that are directly linked to criminal behaviour. Eight criminogenic needs are measured in OASys: Accommodation, Employability, Relationships, Lifestyle and Associates, Drug Misuse, Alcohol Misuse, Thinking & Behaviour and Attitudes. These are scored according to whether there is “no need”, “some need” or “severe need”, and a need is identified in a specific section based on calculations around these scores.
               However, the process by which needs are assessed is changing as early as next year (2024), specifically moving to a strength-based model that seeks to identify and develop the strengths of people with convictions. As a consequence of this, the information provided by this endpoint will also change.
       parameters:
@@ -463,14 +463,31 @@ paths:
         "200":
           description: Success.
 
-  /{TBC}/v1/persons/{Id}/adjudications:
+  /v1/persons/{Id}/adjudications:
     get:
-      summary: FUTURE ENDPOINT - Returns adjudications associated with a person.
+      summary: Returns adjudications associated with a person.
       parameters:
-        - $ref: "#/components/parameters/Id"
+        - name: hmppsId
+          in: path
+          required: true
+          schema:
+            type: string
       responses:
         "200":
-          description: Success.
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Adjudication'
+        "404":
+          description: "Adjudications for the person with the provided HmppsId does not exist."
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+              examples:
+                PersonNotFoundError:
+                  $ref: "#/components/examples/PersonNotFoundError"
 
   /{TBC}/v1/persons/{Id}/interventions:
     get:
@@ -631,6 +648,33 @@ components:
           type: string
           example: Business Address
           description: Description of address type
+    Adjudication:
+      type: object
+      properties:
+        incidentDetails:
+          $ref: '#/components/schemas/IncidentDetails'
+        isYouthOffender:
+          type: boolean
+        incidentRole:
+          $ref: '#/components/schemas/IncidentRole'
+        offenceDetails:
+          $ref: '#/components/schemas/OffenceDetail'
+        hearings:
+          type: array
+          items:
+            $ref: '#/components/schemas/Hearing'
+        outcomes:
+          type: array
+          items:
+            $ref: '#/components/schemas/Outcome'
+        punishments:
+          type: array
+          items:
+            $ref: '#/components/schemas/Punishment'
+        punishmentComments:
+          type: array
+          items:
+            $ref: '#/components/schemas/PunishmentComment'
     Alert:
       type: object
       properties:
@@ -774,6 +818,36 @@ components:
           type: string
           nullable: true
           example: null
+    Hearing:
+      type: object
+      properties:
+        dateTimeOfHearing:
+          type: string
+          format: date-time
+          nullable: true
+        oicHearingType:
+          type: string
+          nullable: true
+        outcome:
+          nullable: true
+    HearingOutcome:
+      type: object
+      properties:
+        code:
+          type: string
+          nullable: true
+        details:
+          type: string
+          nullable: true
+        reason:
+          type: string
+          nullable: true
+        quashedReason:
+          type: string
+          nullable: true
+        canRemove:
+          type: boolean
+          nullable: true
     Identifiers:
       type: object
       description: Other unique identifiers for a person.
@@ -862,6 +936,21 @@ components:
               `OFF_IDM` - Offender Identification Marks,
               `OIC` - Offence In Custody,
               `PPTY` - Property Image
+    IncidentDetails:
+      type: object
+      properties:
+        dateTimeOfIncident:
+          type: string
+          format: date-time
+          nullable: true
+    IncidentRole:
+      type: object
+      properties:
+        roleCode:
+          type: string
+          nullable: true
+        offenceRule:
+          nullable: true
     LatestSentenceKeyDatesAndAdjustments:
       type: object
       properties:
@@ -925,6 +1014,41 @@ components:
           type: string
           example: RR84
           description: Statute code
+    OffenceDetail:
+      type: object
+      properties:
+        offenceCode:
+          type: number
+          nullable: true
+        offenceRule:
+          nullable: true
+    OffenceRuleDetails:
+      type: object
+      properties:
+        paragraphNumber:
+          type: string
+          nullable: true
+        paragraphDescription:
+          type: string
+          nullable: true
+    Outcome:
+      type: object
+      properties:
+        code:
+          type: string
+          nullable: true
+        details:
+          type: string
+          nullable: true
+        reason:
+          type: string
+          nullable: true
+        quashedReason:
+          type: string
+          nullable: true
+        canRemove:
+          type: boolean
+          nullable: true
     Pagination:
       type: object
       properties:
@@ -997,6 +1121,51 @@ components:
           type: string
           example: 2008/0545166T
           description: Currently a hmppsId is a PNC identifier however this will change in the near future to be a CRN identifier
+    Punishment:
+      type: object
+      properties:
+        type:
+          type: string
+          nullable: true
+        privilegeType:
+          type: string
+          nullable: true
+        otherPrivilege:
+          type: string
+          nullable: true
+        schedule:
+          nullable: true
+    PunishmentComment:
+      type: object
+      properties:
+        comment:
+          type: string
+          nullable: true
+        reasonForChange:
+          type: string
+          nullable: true
+        dateTime:
+          type: string
+          format: date-time
+          nullable: true
+    PunishmentSchedule:
+      type: object
+      properties:
+        days:
+          type: number
+          nullable: true
+        startDate:
+          type: string
+          format: date
+          nullable: true
+        endDate:
+          type: string
+          format: date
+          nullable: true
+        suspendedUntil:
+          type: string
+          format: date
+          nullable: true
     ResponsibleProvider:
       required:
         - code

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/AdjudicationsGateway.kt

@@ -5,7 +5,7 @@ import org.springframework.beans.factory.annotation.Value
 import org.springframework.http.HttpMethod
 import org.springframework.stereotype.Component
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.WebClientWrapper
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications.ReportedAdjudicationDto
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications.ReportedAdjudication
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Adjudication
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
@@ -18,7 +18,7 @@ class AdjudicationsGateway(@Value("\${services.adjudications.base-url}") baseUrl
   lateinit var hmppsAuthGateway: HmppsAuthGateway
 
   fun getReportedAdjudicationsForPerson(id: String): Response<List<Adjudication>> {
-    val result = webClient.requestList<ReportedAdjudicationDto>(
+    val result = webClient.requestList<ReportedAdjudication>(
       HttpMethod.GET,
       "/reported-adjudications/prisoner/$id",
       authenticationHeader(),

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationHearingOutcome.kt

@@ -0,0 +1,10 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+class AdjudicationHearingOutcome(
+  val id: Number? = null,
+  val adjudicator: String? = null,
+  val code: String? = null,
+  val reason: String? = null,
+  val details: String? = null,
+  val plea: String? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsCombinedOutcome.kt

@@ -0,0 +1,6 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+class AdjudicationsCombinedOutcome(
+  val outcome: AdjudicationsOutcome? = null,
+  val referralOutcome: AdjudicationsOutcome? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsHearing.kt

@@ -0,0 +1,10 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+data class AdjudicationsHearing(
+  val id: Number? = null,
+  val locationId: Number? = null,
+  val dateTimeOfHearing: String? = null,
+  val oicHearingType: String? = null,
+  val outcome: AdjudicationHearingOutcome? = null,
+  val agencyId: String? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsIncidentDetails.kt

@@ -0,0 +1,7 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+data class AdjudicationsIncidentDetails(
+  val locationId: Number? = null,
+  val dateTimeOfIncident: String? = null,
+  val dateTimeOfDiscovery: String? = null,
+  val handoverDeadline: String? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsIncidentRole.kt

@@ -0,0 +1,6 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+data class AdjudicationsIncidentRole(
+  val roleCode: String? = null,
+  val offenceRule: AdjudicationsOffenceRuleDetails? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsOffenceDetails.kt

@@ -0,0 +1,9 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+class AdjudicationsOffenceDetails(
+  val offenceCode: Number? = null,
+  val offenceRule: AdjudicationsOffenceRule? = null,
+  val victimPrisonersNumber: String? = null,
+  val victimStaffUsername: String? = null,
+  val victimOtherPersonsName: String? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsOffenceRule.kt

@@ -0,0 +1,8 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+class AdjudicationsOffenceRule(
+  val paragraphNumber: String? = null,
+  val paragraphDescription: String? = null,
+  val nomisCode: String? = null,
+  val withOthersNomisCode: String? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsOffenceRuleDetails.kt

@@ -0,0 +1,6 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+data class AdjudicationsOffenceRuleDetails(
+  val paragraphNumber: String? = null,
+  val paragraphDescription: String? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsOutcome.kt

@@ -0,0 +1,10 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+class AdjudicationsOutcome(
+  val id: Number? = null,
+  val code: String? = null,
+  val details: String? = null,
+  val reason: String? = null,
+  val quashedReason: String? = null,
+  val canRemove: Boolean? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsOutcomeHistory.kt

@@ -0,0 +1,5 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+class AdjudicationsOutcomeHistory(
+  val hearing: AdjudicationsHearing? = null,
+  val outcome: AdjudicationsCombinedOutcome? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsPunishment.kt

@@ -0,0 +1,16 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+class AdjudicationsPunishment(
+  val id: Number? = null,
+  val type: String? = null,
+  val privilegeType: String? = null,
+  val otherPrivilege: String? = null,
+  val stoppagePercentage: Number? = null,
+  val activatedBy: String? = null,
+  val activatedFrom: String? = null,
+  val schedule: AdjudicationsPunishmentSchedule? = null,
+  val consecutiveChargeNumber: String? = null,
+  val consecutiveReportAvailable: Boolean? = null,
+  val damagesOwedAmount: Number? = null,
+  val canRemove: Boolean? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsPunishmentComment.kt

@@ -0,0 +1,8 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+class AdjudicationsPunishmentComment(
+  val id: Number? = null,
+  val comment: String? = null,
+  val reasonForChange: String? = null,
+  val dateTime: String? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/adjudications/AdjudicationsPunishmentSchedule.kt

@@ -0,0 +1,8 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.adjudications
+
+class AdjudicationsPunishmentSchedule(
+  val days: Number? = null,
+  val startDate: String? = null,
+  val endDate: String? = null,
+  val suspendedUntil: String? = null,
+)