generated from ministryofjustice/hmpps-template-kotlin
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathopenapi.yml
1747 lines (1707 loc) · 54.8 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: HMPPS Integration API
description:
A long-lived API that exposes data from HMPPS systems such as the National Offender Management Information
System (NOMIS), nDelius (probation system) and Offender Assessment System (OASys), providing a single point
of entry for consumers.
version: 0.0.1
paths:
/v1/persons:
get:
tags:
- persons
summary: Returns person(s) by search criteria. At least one query parameter must be specified.
parameters:
- in: query
name: first_name
schema:
type: string
required: false
description: The first name of the person
- in: query
name: last_name
schema:
type: string
required: false
description: The last name of the person
- in: query
name: pnc_number
schema:
type: string
required: false
description: A URL-encoded pnc identifier
- in: query
name: date_of_birth
schema:
type: string
required: false
description: The date of birth of the person
- in: query
name: search_within_aliases
schema:
type: boolean
default: false
required: false
description: Whether to return results that match the search criteria within the aliases of a person
- $ref: "#/components/parameters/Page"
- $ref: "#/components/parameters/PerPage"
responses:
"200":
description: Successfully performed the query on upstream APIs. An empty list is returned when no results are found.
content:
application/json:
schema:
type: object
properties:
data:
type: array
minItems: 0
items:
$ref: "#/components/schemas/Person"
pagination:
$ref: "#/components/schemas/Pagination"
"400":
description: There were no query parameters passed in. At least one must be specified.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
NoQueryParametersBadRequestError:
$ref: "#/components/examples/NoQueryParametersBadRequestError"
/v1/persons/{hmppsId}:
get:
tags:
- persons
summary: Returns a person.
parameters:
- $ref: "#/components/parameters/HmppsId"
responses:
"200":
description: Successfully found a person with the provided HMPPS ID.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
prisonerOffenderSearch:
$ref: "#/components/schemas/Person"
probationOffenderSearch:
$ref: "#/components/schemas/Person"
"404":
description: Failed to find a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/persons/{hmppsId}/images:
get:
tags:
- persons
summary: Returns metadata of images associated with a person.
parameters:
- $ref: "#/components/parameters/HmppsId"
- $ref: "#/components/parameters/Page"
- $ref: "#/components/parameters/PerPage"
responses:
"200":
description: >
Successfully found a person with the provided HMPPS ID.
If a person doesn't have any images, then an empty list (`[]`) is
returned in the `data` property.
content:
application/json:
schema:
type: object
properties:
data:
type: array
minItems: 0
items:
$ref: "#/components/schemas/Image"
pagination:
$ref: "#/components/schemas/Pagination"
"404":
description: Failed to find a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/images/{id}:
get:
tags:
- images
summary: Returns an image in bytes as a JPEG.
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: Successfully found an image with the provided ID.
content:
image/jpeg:
schema:
type: string
format: byte
"404":
description: Failed to find an image with the provided ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
ImageNotFoundError:
$ref: "#/components/examples/ImageNotFoundError"
/v1/persons/{hmppsId}/addresses:
get:
tags:
- persons
summary: Returns addresses associated with a person.
parameters:
- $ref: "#/components/parameters/HmppsId"
- $ref: "#/components/parameters/Page"
- $ref: "#/components/parameters/PerPage"
responses:
"200":
description: Successfully found a person with the provided HMPPS ID.
content:
application/json:
schema:
type: object
properties:
data:
type: array
minItems: 0
items:
$ref: "#/components/schemas/Address"
pagination:
$ref: "#/components/schemas/Pagination"
"404":
description: Failed to find a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/persons/{hmppsId}/offences:
get:
tags:
- 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.
parameters:
- $ref: "#/components/parameters/HmppsId"
- $ref: "#/components/parameters/Page"
- $ref: "#/components/parameters/PerPage"
responses:
"200":
description: Successfully found offences for a person with the provided HMPPS ID.
content:
application/json:
schema:
type: object
properties:
data:
type: array
minItems: 0
items:
$ref: "#/components/schemas/Offence"
pagination:
$ref: "#/components/schemas/Pagination"
"404":
description: Failed to find offences a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/persons/{hmppsId}/alerts:
get:
tags:
- persons
- alerts
summary: Returns alerts associated with a person.
parameters:
- $ref: "#/components/parameters/HmppsId"
- $ref: "#/components/parameters/Page"
- $ref: "#/components/parameters/PerPage"
responses:
"200":
description: Successfully found alerts for a person with the provided HMPPS ID.
content:
application/json:
schema:
type: object
properties:
data:
type: array
minItems: 0
items:
$ref: "#/components/schemas/Alert"
pagination:
$ref: "#/components/schemas/Pagination"
"404":
description: Failed to find alerts a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/persons/{hmppsId}/sentences:
get:
tags:
- persons
summary: Returns sentences associated with a person.
parameters:
- $ref: "#/components/parameters/HmppsId"
- $ref: "#/components/parameters/Page"
- $ref: "#/components/parameters/PerPage"
responses:
"200":
description: Successfully found sentences for a person with the provided HMPPS ID.
content:
application/json:
schema:
type: object
properties:
data:
type: array
minItems: 0
items:
$ref: "#/components/schemas/Sentence"
pagination:
$ref: "#/components/schemas/Pagination"
"404":
description: Failed to find sentences a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/persons/{hmppsId}/sentences/latest-key-dates-and-adjustments:
get:
tags:
- persons
summary: Returns the key dates and adjustments about a person's release from prison for their latest sentence.
parameters:
- $ref: "#/components/parameters/HmppsId"
responses:
"200":
description: Successfully found latest sentence key dates and adjustments for a person with the provided HMPPS ID.
content:
application/json:
schema:
type: object
properties:
data:
$ref: "#/components/schemas/LatestSentenceKeyDatesAndAdjustments"
"404":
description: Failed to find sentences a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/persons/{hmppsId}/risks/scores:
get:
tags:
- risks
summary: Returns risk scores from the last year associated with a person.
parameters:
- $ref: "#/components/parameters/HmppsId"
- $ref: "#/components/parameters/Page"
- $ref: "#/components/parameters/PerPage"
responses:
"200":
description: Successfully found risk scores for a person with the provided HMPPS ID.
content:
application/json:
schema:
type: object
properties:
data:
type: array
minItems: 0
items:
$ref: "#/components/schemas/RiskScore"
pagination:
$ref: "#/components/schemas/Pagination"
"404":
description: Failed to find risk scores for a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/persons/{hmppsId}/needs:
get:
tags:
- 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:
- $ref: "#/components/parameters/HmppsId"
responses:
"200":
description: Successfully found criminogenic needs for a person with the provided HMPPS ID.
content:
application/json:
schema:
type: object
properties:
data:
$ref: "#/components/schemas/Needs"
"404":
description: Failed to find criminogenic needs for a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/persons/{hmppsId}/risks:
get:
tags:
- risks
summary: Returns Risk of Serious Harm (ROSH) risks associated with a person. Returns only assessments completed in the last year.
parameters:
- $ref: "#/components/parameters/HmppsId"
responses:
"200":
description: Successfully found risks for a person with the provided HMPPS ID.
content:
application/json:
schema:
type: object
properties:
data:
$ref: "#/components/schemas/Risks"
"404":
description: Failed to find risks for a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/epf/person-details/{hmppsId}/{eventNumber}:
get:
summary: Probation case information for the Effective Proposals Framework service
description: "<p>Accepts a Hmpps Id (hmppsId) and Delius Event number\n\
\ and returns a data structure giving background information on\
\ the probation case\n for use in the Effective Proposals Framework\
\ system. The information is used to\n reduce the need for the\
\ EPF user to re-key information already held in Delius.</p> "
parameters:
- name: hmppsId
in: path
required: true
schema:
type: string
- name: eventNumber
in: path
required: true
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CaseDetails'
"404":
description: "A person detail with the provided HmppsId and event number does not exist in Delius."
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/v1/persons/{Id}/adjudications:
get:
summary: Returns adjudications associated with a person.
parameters:
- name: hmppsId
in: path
required: true
schema:
type: string
responses:
"200":
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"
/v1/persons/{HmppsId}/licences/conditions:
get:
summary: Returns license conditions associated with a person.
parameters:
- $ref: "#/components/parameters/HmppsId"
responses:
"200":
description: Successfully found licenses for a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/PersonLicencesData"
"404":
description: Failed to find licenses for a person with the provided HMPPS ID.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
PersonNotFoundError:
$ref: "#/components/examples/PersonNotFoundError"
/{TBC}/v1/persons/{Id}/accommodations:
get:
summary: FUTURE ENDPOINT - Returns accommodation and referral information associated with a person.
parameters:
- $ref: "#/components/parameters/Id"
responses:
"200":
description: Success.
/{TBC}/v1/persons/{Id}/interventions:
get:
summary: FUTURE ENDPOINT - Returns activities and Non-Statutory Interventions (NSIs) associated with a person.
parameters:
- $ref: "#/components/parameters/Id"
responses:
"200":
description: Success.
/{TBC}/v1/persons/{Id}/key-workers:
get:
summary: FUTURE ENDPOINT - Returns responsible officer history, transfer history and consolidated transfer review associated with a person.
parameters:
- $ref: "#/components/parameters/Id"
responses:
"200":
description: Success.
/{TBC}/v1/persons/{Id}/prisoner-visits:
get:
summary: FUTURE ENDPOINT - Returns prisoner visits associated with a person.
parameters:
- $ref: "#/components/parameters/Id"
responses:
"200":
description: Success.
/{TBC}/v1/persons/{Id}/probation-contact-events:
get:
summary: FUTURE ENDPOINT - Returns probation contact events associated with a person.
parameters:
- $ref: "#/components/parameters/Id"
responses:
"200":
description: Success.
/{TBC}/v1/persons/{Id}/security:
get:
summary: FUTURE ENDPOINT - Returns security information such as prisoner non-associations and prisoner incidents for a person.
parameters:
- $ref: "#/components/parameters/Id"
responses:
"200":
description: Success.
/{TBC}/v1/persons/{Id}/special-needs:
get:
summary: FUTURE ENDPOINT - Returns special needs such as drugs test summaries, drug history and drugs test lists associated with a person.
parameters:
- $ref: "#/components/parameters/Id"
responses:
"200":
description: Success.
components:
parameters:
HmppsId:
name: hmppsId
description: A URL-encoded HMPPS identifier
example: 2008%2F0545166T
in: path
required: true
schema:
type: string
Id:
name: Id
description: An Id (TBC), potentially Case Reference Number (CRN)
example: X00001
in: path
required: true
schema:
type: string
Page:
name: page
in: query
schema:
type: number
minimum: 0
default: 1
required: false
description: The page number (starting from 1)
PerPage:
name: perPage
in: query
schema:
type: number
minimum: 1
default: 10
required: false
description: The maximum number of results for a page
schemas:
Address:
type: object
properties:
country:
type: string
example: England
county:
type: string
example: Greater London
endDate:
type: string
example: 20 May 2023
format: date
locality:
type: string
example: London Bridge
name:
type: string
description: Name of the building of residence
noFixedAddress:
type: boolean
example: true
description: Indicates whether the person has a permanent place of residence
number:
type: string
example: 1
postcode:
type: string
example: SE1 1TE
startDate:
type: string
example: 1 January 2023
format: date
street:
type: string
example: O'Meara Street
town:
type: string
example: London
types:
type: array
minItems: 0
items:
$ref: "#/components/schemas/AddressType"
description: Type or usage of address
notes:
type: string
example: This is their partner's address.
AddressType:
type: object
properties:
code:
type: string
example: BUS
description: Address type code
description:
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:
offenderNo:
type: string
example: Z1234ZZ
description: Offender unique reference
type:
type: string
example: X
description: Alert type
typeDescription:
type: string
example: Security
description: Alert type description
code:
type: string
example: PO
description: Alert code
codeDescription:
type: string
example: MAPPA Nominal
description: Alert code description
comment:
type: string
example: Professional lock pick
description: Alert comment
dateCreated:
type: string
format: date
example: 2014-09-23
description: Date of the alert, which might differ from the date it was created
dateExpired:
type: string
format: date
example: 2015-09-23
description: Date that the alert expires
expired:
type: boolean
example: true
description: Whether the alert has expired
active:
type: boolean
example: false
description: Whether the alert is active
Alias:
type: object
properties:
firstName:
type: string
example: John
description: first name
middleName:
type: string
example: Michael
nullable: true
description: middle name
lastName:
type: string
example: Marston
description: last name
dateOfBirth:
type: string
format: date
example: 1965-12-01
description: date of birth
gender:
type: string
example: Male
description: gender
ethnicity:
type: string
example: Prefer not to say
description: ethnicity
CaseDetails:
required:
- age
- dateOfBirth
- gender
- name
type: object
properties:
nomsId:
type: string
name:
$ref: '#/components/schemas/Name'
dateOfBirth:
type: string
format: date
gender:
type: string
sentence:
$ref: '#/components/schemas/CaseSentence'
responsibleProvider:
$ref: '#/components/schemas/ResponsibleProvider'
ogrsScore:
type: integer
format: int64
age:
type: integer
format: int64
ageAtRelease:
type: integer
format: int64
CaseSentence:
required:
- date
- sentencingCourt
type: object
properties:
date:
type: string
format: date
sentencingCourt:
$ref: '#/components/schemas/Court'
releaseDate:
type: string
format: date
ContactDetails:
properties:
addresses:
type: array
description: A list of known addresses
properties:
Address:
$ref: "#/components/schemas/Address"
phoneNumbers:
$ref: "#/components/schemas/PhoneNumbers"
description: A list of phone numbers and type of phone number (mobile, landline etc...)
emails:
type: array
example: "leslie.knope@pawnee.gov"
description: A list of email addresses
Court:
required:
- name
type: object
properties:
name:
type: string
Error:
type: object
properties:
status:
type: integer
enum: [ 400, 404, 500 ]
errorCode:
type: integer
nullable: true
example: null
userMessage:
type: string
developerMessage:
type: string
moreInfo:
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.
properties:
nomisNumber:
type: string
example: A1234AA
description: A prisoner identifier from NOMIS.
croNumber:
type: string
example: SF80/655108T
description: A Criminal Records Office identifier from National Identification Service (NIS) or National Automated Fingerprint Identification System (NAFIS).
deliusCrn:
type: string
example: X00001
description: A Case Reference Number from Delius.
Image:
type: object
properties:
id:
type: integer
minimum: 1
format: int64
example: 2461788
description: The Image ID, in reference to a unique identifier.
active:
type: boolean
example: true
description: A flag to indicate whether an image is in active use. It is no guarantee that the latest uploaded image will be the active one.
captureDateTime:
type: string
format: date-time
example: 2015-05-27T17:13:59
description: The Date and Time of when the image was captured.
view:
type: string
example: FACE
enum: [FACE, TAT, OTH, SCAR, MARK, OIC]
description: >
View is the subject focus; describing the inner focus or subject of the image, normally referring to a marking, tattoo or deeper level focus of the orientation. In practise this is the interior foci of what is captured in the 'orientation' field.
Options include:
`FACE` - Facing,
`TAT` - Tattoo,
`OTH` - Other,
`SCAR` - Scar,
`MARK` - Mark,
`OIC` - Offence in Custody
orientation:
type: string
example: FRONT
enum: [ANKLE, ARM, DAMAGE, EAR, ELBOW, FACE, FIGHT, FINGER, FOOT, FRONT, HAND, HEAD, INCIDENT, INJURY, KNEE, LEG, LIP, NECK, NOSE, SHOULDER, THIGH, TOE, TORSO]
description: >
Orientation is the scope focus; describing the scope or outer focus of the image, normally referring to the highest level object of interest within the bounds of the photo itself. This is normally a body part or an angle of photography, such as a photo of someone’s facial view (`FRONT`) or arm (`ARM`).
Options include:
`ANKLE` - Ankle,
`ARM` - Arm,
`DAMAGE` - Damage,
`EAR` - Ear,
`ELBOW` - Elbow,
`FACE` - Face,
`FIGHT` - Fight,
`FINGER` - Finger,
`FOOT` - Foot,
`FRONT` - Front Facial View,
`HAND` - Hand,
`HEAD` - Head,
`INCIDENT` - Incident,
`INJURY` - Injury,
`KNEE` - Knee,
`LEG` - Leg,
`LIP` - Lip,
`NECK` - Neck,
`NOSE` - Nose,
`SHOULDER` - Shoulder,
`THIGH` - Thigh,
`TOE` - Toe,
`TORSO` - Torso
type:
type: string
example: OFF_BKG
enum: [OFF_BKG, OFF_IDM, OIC, PPTY]
description: >
Type is the contextual focus; describing the context or scenario the image was taken within. It could be for a particular purpose or capturing the results of a particular type of incident.
Options include:
`OFF_BKG` - Offender Booking,
`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:
adjustments:
$ref: "#/components/schemas/SentenceAdjustments"