|
1 | 1 | package uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.response
|
2 | 2 |
|
3 |
| -import java.time.LocalDate |
4 | 3 | import com.fasterxml.jackson.annotation.JsonInclude
|
5 | 4 | import com.fasterxml.jackson.annotation.JsonInclude.Include
|
6 | 5 | import io.swagger.v3.oas.annotations.media.Schema
|
| 6 | +import java.time.LocalDate |
7 | 7 |
|
8 | 8 | @JsonInclude(Include.NON_NULL)
|
9 | 9 | @Schema(description = "DTO representing a military record with details about service in the UK Armed Forces.")
|
10 | 10 | data class MilitaryRecordDto(
|
11 | 11 | @Schema(
|
12 | 12 | description = "Code identifying the war zone where the service took place.",
|
13 |
| - example = "AFG" |
| 13 | + example = "AFG", |
14 | 14 | )
|
15 | 15 | val warZoneCode: String?,
|
16 | 16 |
|
17 | 17 | @Schema(
|
18 | 18 | description = "Description of the war zone where the service took place.",
|
19 |
| - example = "Afghanistan" |
| 19 | + example = "Afghanistan", |
20 | 20 | )
|
21 | 21 | val warZoneDescription: String?,
|
22 | 22 |
|
23 | 23 | @Schema(
|
24 | 24 | description = "Start date of the military service.",
|
25 |
| - example = "2017-06-01" |
| 25 | + example = "2017-06-01", |
26 | 26 | )
|
27 | 27 | val startDate: LocalDate,
|
28 | 28 |
|
29 | 29 | @Schema(
|
30 | 30 | description = "End date of the military service, if applicable.",
|
31 |
| - example = "2019-12-01" |
| 31 | + example = "2019-12-01", |
32 | 32 | )
|
33 | 33 | val endDate: LocalDate?,
|
34 | 34 |
|
35 | 35 | @Schema(
|
36 | 36 | description = "Code indicating the discharge status from the UK military forces.",
|
37 |
| - example = "HON" |
| 37 | + example = "HON", |
38 | 38 | )
|
39 | 39 | val militaryDischargeCode: String?,
|
40 | 40 |
|
41 | 41 | @Schema(
|
42 | 42 | description = "Description of the discharge status from the UK military forces.",
|
43 |
| - example = "Honourable" |
| 43 | + example = "Honourable", |
44 | 44 | )
|
45 | 45 | val militaryDischargeDescription: String?,
|
46 | 46 |
|
47 | 47 | @Schema(
|
48 | 48 | description = "Code identifying the branch of the UK military in which the individual served.",
|
49 |
| - example = "ARM" |
| 49 | + example = "ARM", |
50 | 50 | )
|
51 | 51 | val militaryBranchCode: String,
|
52 | 52 |
|
53 | 53 | @Schema(
|
54 | 54 | description = "Description of the military branch of the UK Armed Forces.",
|
55 |
| - example = "Army" |
| 55 | + example = "Army", |
56 | 56 | )
|
57 | 57 | val militaryBranchDescription: String,
|
58 | 58 |
|
59 | 59 | @Schema(
|
60 | 60 | description = "Additional notes or details about the military service.",
|
61 |
| - example = "Deployed to Afghanistan in support of Operation Herrick." |
| 61 | + example = "Deployed to Afghanistan in support of Operation Herrick.", |
62 | 62 | )
|
63 | 63 | val description: String?,
|
64 | 64 |
|
65 | 65 | @Schema(
|
66 | 66 | description = "Unit number in which the individual served.",
|
67 |
| - example = "2nd Battalion, The Royal Anglian Regiment" |
| 67 | + example = "2nd Battalion, The Royal Anglian Regiment", |
68 | 68 | )
|
69 | 69 | val unitNumber: String?,
|
70 | 70 |
|
71 | 71 | @Schema(
|
72 | 72 | description = "Location where the individual enlisted in the UK military.",
|
73 |
| - example = "Windsor, Berkshire" |
| 73 | + example = "Windsor, Berkshire", |
74 | 74 | )
|
75 | 75 | val enlistmentLocation: String?,
|
76 | 76 |
|
77 | 77 | @Schema(
|
78 | 78 | description = "Location where the individual was discharged from the UK military.",
|
79 |
| - example = "Colchester, Essex" |
| 79 | + example = "Colchester, Essex", |
80 | 80 | )
|
81 | 81 | val dischargeLocation: String?,
|
82 | 82 |
|
83 | 83 | @Schema(
|
84 | 84 | description = "Flag indicating if the individual was registered for UK selective military service (National Service).",
|
85 |
| - example = "false" |
| 85 | + example = "false", |
86 | 86 | )
|
87 | 87 | val selectiveServicesFlag: Boolean,
|
88 | 88 |
|
89 | 89 | @Schema(
|
90 | 90 | description = "Code identifying the individual's military rank in the UK forces.",
|
91 |
| - example = "CPL_ARM" |
| 91 | + example = "CPL_ARM", |
92 | 92 | )
|
93 | 93 | val militaryRankCode: String?,
|
94 | 94 |
|
95 | 95 | @Schema(
|
96 | 96 | description = "Description of the individual's military rank in the UK forces.",
|
97 |
| - example = "Corporal" |
| 97 | + example = "Corporal", |
98 | 98 | )
|
99 | 99 | val militaryRankDescription: String?,
|
100 | 100 |
|
101 | 101 | @Schema(
|
102 | 102 | description = "Service number of the individual within the UK military.",
|
103 |
| - example = "2345678" |
| 103 | + example = "2345678", |
104 | 104 | )
|
105 | 105 | val serviceNumber: String?,
|
106 | 106 |
|
107 | 107 | @Schema(
|
108 | 108 | description = "Code identifying any disciplinary actions taken against the individual during service.",
|
109 |
| - example = "CM" |
| 109 | + example = "CM", |
110 | 110 | )
|
111 | 111 | val disciplinaryActionCode: String?,
|
112 | 112 |
|
113 | 113 | @Schema(
|
114 | 114 | description = "Description of any disciplinary actions taken against the individual during service.",
|
115 |
| - example = "Court Martial" |
| 115 | + example = "Court Martial", |
116 | 116 | )
|
117 |
| - val disciplinaryActionDescription: String? |
| 117 | + val disciplinaryActionDescription: String?, |
118 | 118 | )
|
0 commit comments