CDPS-1140: Military History (#23)

* CDPS-1140: Military History
Remove bookingId from DTOs
Add parentCode and parentDomain to ref data DTO

* Address PR comments

Author: davidatmoj

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/common/client/PrisonApiClient.kt

@@ -8,9 +8,8 @@ import org.springframework.web.service.annotation.HttpExchange
 import org.springframework.web.service.annotation.PostExchange
 import org.springframework.web.service.annotation.PutExchange
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateBirthCountry
-import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.CreateMilitaryRecord
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.MilitaryRecordRequest
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateBirthPlace
-import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateMilitaryRecord
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateNationality
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateReligion
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.response.MilitaryRecordPrisonDto
@@ -40,16 +39,17 @@ interface PrisonApiClient {
     @PathVariable offenderNo: String,
   ): ResponseEntity<MilitaryRecordPrisonDto>
 
-  @PutExchange("/{offenderNo}/military-records")
+  @PutExchange("/{offenderNo}/military-records/{militarySeq}")
   fun updateMilitaryRecord(
     @PathVariable offenderNo: String,
-    @RequestBody updateMilitaryRecord: UpdateMilitaryRecord,
+    @PathVariable militarySeq: Int,
+    @RequestBody militaryRecordRequest: MilitaryRecordRequest,
   ): ResponseEntity<Void>
 
   @PostExchange("/{offenderNo}/military-records")
   fun createMilitaryRecord(
     @PathVariable offenderNo: String,
-    @RequestBody createMilitaryRecord: CreateMilitaryRecord,
+    @RequestBody militaryRecordRequest: MilitaryRecordRequest,
   ): ResponseEntity<Void>
 
   @PutExchange("/{offenderNo}/religion")

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/common/client/request/CreateMilitaryRecord.kt src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/common/client/request/MilitaryRecordRequest.kt

@@ -3,8 +3,8 @@ package uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request
 import io.swagger.v3.oas.annotations.media.Schema
 import java.time.LocalDate
 
-@Schema(description = "Create a military record.")
-class CreateMilitaryRecord(
+@Schema(description = "Military record request object. Used to create or update a military record.")
+class MilitaryRecordRequest(
   @Schema(
     description = "Code identifying the war zone where the service took place.",
     example = "AFG",

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/common/client/request/UpdateMilitaryRecord.kt

@@ -6,4 +6,6 @@ data class ReferenceDataCode(
   val description: String,
   val activeFlag: String,
   val listSeq: Int,
+  val parentCode: String? = null,
+  val parentDomain: String? = null,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/common/client/response/ReferenceDataCode.kt

@@ -30,4 +30,10 @@ data class ReferenceDataCodeDto(
     example = "true",
   )
   val isActive: Boolean,
+
+  @Schema(description = "Parent code for the reference data code", example = "EU")
+  val parentCode: String? = null,
+
+  @Schema(description = "Parent domain for the reference data code", example = "REGION")
+  val parentDomain: String? = null,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/common/dto/ReferenceDataCodeDto.kt

@@ -8,12 +8,6 @@ import java.time.LocalDate
 @JsonInclude(Include.NON_NULL)
 @Schema(description = "DTO representing a military record with details about service in the UK Armed Forces.")
 data class MilitaryRecordDto(
-  @Schema(
-    description = "Booking ID of the prisoner.",
-    example = "1234567",
-  )
-  val bookingId: Long,
-
   @Schema(
     description = "Sequence number of the military record within the booking.",
     example = "1",

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/corepersonrecord/dto/response/MilitaryRecordDto.kt

@@ -25,8 +25,7 @@ import org.springframework.web.bind.annotation.ResponseStatus
 import org.springframework.web.bind.annotation.RestController
 import org.springframework.web.multipart.MultipartFile
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.annotation.ValidPrisonerNumber
-import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.CreateMilitaryRecord
-import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateMilitaryRecord
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.MilitaryRecordRequest
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateNationality
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.dto.ReferenceDataCodeDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.CorePersonRecordRoleConstants
@@ -205,7 +204,7 @@ class CorePersonRecordV1Resource(
       ApiResponse(
         responseCode = "200",
         description = "Military records found",
-        content = [Content(array = ArraySchema(schema = Schema(implementation = ReferenceDataCodeDto::class)))],
+        content = [Content(array = ArraySchema(schema = Schema(implementation = MilitaryRecordDto::class)))],
       ),
       ApiResponse(
         responseCode = "401",
@@ -280,8 +279,9 @@ class CorePersonRecordV1Resource(
   @PreAuthorize("hasRole('${CorePersonRecordRoleConstants.CORE_PERSON_RECORD_READ_WRITE_ROLE}')")
   fun putMilitaryRecord(
     @RequestParam(required = true) @Valid @ValidPrisonerNumber prisonerNumber: String,
-    @RequestBody(required = true) @Valid updateMilitaryRecord: UpdateMilitaryRecord,
-  ): ResponseEntity<Void> = corePersonRecordService.updateMilitaryRecord(prisonerNumber, updateMilitaryRecord)
+    @RequestParam(required = true) militarySeq: Int,
+    @RequestBody(required = true) @Valid militaryRecordRequest: MilitaryRecordRequest,
+  ): ResponseEntity<Void> = corePersonRecordService.updateMilitaryRecord(prisonerNumber, militarySeq, militaryRecordRequest)
 
   @PostMapping("/military-records")
   @ResponseStatus(HttpStatus.CREATED)
@@ -329,8 +329,8 @@ class CorePersonRecordV1Resource(
   @PreAuthorize("hasRole('${CorePersonRecordRoleConstants.CORE_PERSON_RECORD_READ_WRITE_ROLE}')")
   fun postMilitaryRecord(
     @RequestParam(required = true) @Valid @ValidPrisonerNumber prisonerNumber: String,
-    @RequestBody(required = true) @Valid createMilitaryRecord: CreateMilitaryRecord,
-  ): ResponseEntity<Void> = corePersonRecordService.createMilitaryRecord(prisonerNumber, createMilitaryRecord)
+    @RequestBody(required = true) @Valid militaryRecordRequest: MilitaryRecordRequest,
+  ): ResponseEntity<Void> = corePersonRecordService.createMilitaryRecord(prisonerNumber, militaryRecordRequest)
 
   @PutMapping("/nationality")
   @ResponseStatus(HttpStatus.NO_CONTENT)

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/corepersonrecord/resource/CorePersonRecordV1Resource.kt

@@ -5,9 +5,8 @@ import org.springframework.stereotype.Service
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.PrisonApiClient
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.ReferenceDataClient
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateBirthCountry
-import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.CreateMilitaryRecord
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.MilitaryRecordRequest
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateBirthPlace
-import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateMilitaryRecord
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateNationality
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.dto.ReferenceDataCodeDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.response.MilitaryRecordDto
@@ -49,6 +48,8 @@ class CorePersonRecordService(
           it.description,
           it.listSeq,
           it.activeFlag == "Y",
+          it.parentCode,
+          it.parentDomain,
         )
       }
       return ResponseEntity.ok(mappedResponse)
@@ -66,7 +67,6 @@ class CorePersonRecordService(
 
       val mappedResponse = response.body?.militaryRecords?.map {
         MilitaryRecordDto(
-          bookingId = it.bookingId,
           militarySeq = it.militarySeq,
           warZoneCode = it.warZoneCode,
           warZoneDescription = it.warZoneDescription,
@@ -94,9 +94,9 @@ class CorePersonRecordService(
     }
   }
 
-  fun updateMilitaryRecord(prisonerNumber: String, updateMilitaryRecord: UpdateMilitaryRecord): ResponseEntity<Void> = prisonApiClient.updateMilitaryRecord(prisonerNumber, updateMilitaryRecord)
+  fun updateMilitaryRecord(prisonerNumber: String, militarySeq: Int, militaryRecordRequest: MilitaryRecordRequest): ResponseEntity<Void> = prisonApiClient.updateMilitaryRecord(prisonerNumber, militarySeq, militaryRecordRequest)
 
-  fun createMilitaryRecord(prisonerNumber: String, createMilitaryRecord: CreateMilitaryRecord): ResponseEntity<Void> = prisonApiClient.createMilitaryRecord(prisonerNumber, createMilitaryRecord)
+  fun createMilitaryRecord(prisonerNumber: String, militaryRecordRequest: MilitaryRecordRequest): ResponseEntity<Void> = prisonApiClient.createMilitaryRecord(prisonerNumber, militaryRecordRequest)
 
   fun updateNationality(prisonerNumber: String, updateNationality: UpdateNationality): ResponseEntity<Void> = prisonApiClient.updateNationalityForWorkingName(prisonerNumber, updateNationality)
 }

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/corepersonrecord/service/CorePersonRecordService.kt

@@ -10,8 +10,7 @@ import org.springframework.http.client.MultipartBodyBuilder
 import org.springframework.mock.web.MockMultipartFile
 import org.springframework.web.multipart.MultipartFile
 import org.springframework.web.reactive.function.BodyInserters
-import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.CreateMilitaryRecord
-import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateMilitaryRecord
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.MilitaryRecordRequest
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateNationality
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.dto.ReferenceDataCodeDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.CorePersonRecordRoleConstants
@@ -229,7 +228,6 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
         assertThat(response).isEqualTo(
           listOf(
             MilitaryRecordDto(
-              bookingId = -1L,
               militarySeq = 1,
               warZoneCode = "WZ1",
               warZoneDescription = "War Zone One",
@@ -251,7 +249,6 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
               disciplinaryActionDescription = "Disciplinary Action One",
             ),
             MilitaryRecordDto(
-              bookingId = -1L,
               militarySeq = 2,
               warZoneCode = "WZ2",
               warZoneDescription = "War Zone Two",
@@ -280,13 +277,13 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
 
   @DisplayName("PUT v1/core-person-record/military-records")
   @Nested
-  inner class UpdateMilitaryRecords {
+  inner class UpdateMilitaryRecord {
 
     @Nested
     inner class Security {
       @Test
       fun `access forbidden when no authority`() {
-        webTestClient.put().uri("/v1/core-person-record/military-records?prisonerNumber=$PRISONER_NUMBER")
+        webTestClient.put().uri("/v1/core-person-record/military-records?prisonerNumber=$PRISONER_NUMBER&militarySeq=1")
           .contentType(MediaType.APPLICATION_JSON)
           .bodyValue(UPDATE_MILITARY_RECORD)
           .exchange()
@@ -295,7 +292,7 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
 
       @Test
       fun `access forbidden with wrong role`() {
-        webTestClient.put().uri("/v1/core-person-record/military-records?prisonerNumber=$PRISONER_NUMBER")
+        webTestClient.put().uri("/v1/core-person-record/military-records?prisonerNumber=$PRISONER_NUMBER&militarySeq=1")
           .contentType(MediaType.APPLICATION_JSON)
           .headers(setAuthorisation(roles = listOf("ROLE_IS_WRONG")))
           .bodyValue(UPDATE_MILITARY_RECORD)
@@ -309,7 +306,7 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
 
       @Test
       fun `update military record`() {
-        webTestClient.put().uri("/v1/core-person-record/military-records?prisonerNumber=$PRISONER_NUMBER")
+        webTestClient.put().uri("/v1/core-person-record/military-records?prisonerNumber=$PRISONER_NUMBER&militarySeq=1")
           .contentType(MediaType.APPLICATION_JSON)
           .headers(setAuthorisation(roles = listOf(CorePersonRecordRoleConstants.CORE_PERSON_RECORD_READ_WRITE_ROLE)))
           .bodyValue(UPDATE_MILITARY_RECORD)
@@ -323,7 +320,7 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
 
       @Test
       fun `handles a 404 not found response from downstream api`() {
-        webTestClient.put().uri("/v1/core-person-record/military-records?prisonerNumber=$PRISONER_NUMBER_NOT_FOUND")
+        webTestClient.put().uri("/v1/core-person-record/military-records?prisonerNumber=$PRISONER_NUMBER_NOT_FOUND&militarySeq=1")
           .contentType(MediaType.APPLICATION_JSON)
           .headers(setAuthorisation(roles = listOf(CorePersonRecordRoleConstants.CORE_PERSON_RECORD_READ_WRITE_ROLE)))
           .bodyValue(UPDATE_MILITARY_RECORD)
@@ -336,7 +333,7 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
 
   @DisplayName("POST v1/core-person-record/military-records")
   @Nested
-  inner class CreateMilitaryRecords {
+  inner class CreateMilitaryRecord {
 
     @Nested
     inner class Security {
@@ -511,9 +508,7 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
           .header("Content-Disposition", "form-data; name=imageFile; filename=filename.jpg")
       }
 
-    val UPDATE_MILITARY_RECORD = UpdateMilitaryRecord(
-      bookingId = -1L,
-      militarySeq = 1,
+    val UPDATE_MILITARY_RECORD = MilitaryRecordRequest(
       warZoneCode = "AFG",
       startDate = LocalDate.parse("2021-01-01"),
       militaryDischargeCode = "HON",
@@ -528,7 +523,7 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
       disciplinaryActionCode = "CM",
     )
 
-    val CREATE_MILITARY_RECORD = CreateMilitaryRecord(
+    val CREATE_MILITARY_RECORD = MilitaryRecordRequest(
       startDate = LocalDate.parse("2021-01-01"),
       militaryBranchCode = "NAV",
       selectiveServicesFlag = false,