Skip to content

Commit 031f4aa

Browse files
Changes in Person open-api to reflect new schema
1 parent b3464f6 commit 031f4aa

File tree

1 file changed

+86
-45
lines changed

1 file changed

+86
-45
lines changed

openapi.yml

+86-45
Original file line numberDiff line numberDiff line change
@@ -1719,50 +1719,13 @@ components:
17191719
Person:
17201720
type: object
17211721
properties:
1722-
firstName:
1723-
type: string
1724-
example: Arthur
1725-
description: first name
1726-
middleName:
1727-
type: string
1728-
example: John
1729-
nullable: true
1730-
description: middle name
1731-
lastName:
1732-
type: string
1733-
example: Morgan
1734-
description: last name
1735-
dateOfBirth:
1736-
type: string
1737-
format: date
1738-
example: 1965-12-01
1739-
description: date of birth
1740-
gender:
1741-
type: string
1742-
example: Male
1743-
description: gender
1744-
ethnicity:
1745-
type: string
1746-
example: "White: Eng./Welsh/Scot./N.Irish/British"
1747-
description: ethnicity
1748-
aliases:
1749-
type: array
1750-
minItems: 0
1751-
items:
1752-
$ref: "#/components/schemas/Alias"
1753-
description: list of aliases
1754-
identifiers:
1755-
$ref: "#/components/schemas/Identifiers"
1756-
pncId:
1757-
type: string
1758-
example: 2008/0545166T
1759-
description: An identifier from the Police National Computer (PNC)
1760-
hmppsId:
1761-
type: string
1762-
example: X00001
1763-
description: Currently a hmppsId is a CRN identifier however this will change in the future to be a new unique Hmpps identifier
1764-
contactDetails:
1765-
$ref: "#/components/schemas/ContactDetails"
1722+
data:
1723+
type: object
1724+
properties:
1725+
prisonerOffenderSearch:
1726+
$ref: "#/components/schemas/PrisonerOffenderSearch"
1727+
probationOffenderSearch:
1728+
$ref: "#/components/schemas/ProbationOffenderSearch"
17661729
PersonResponsibleOfficerName:
17671730
type: object
17681731
properties:
@@ -1902,7 +1865,85 @@ components:
19021865
nullable: true
19031866
prison:
19041867
$ref: "#/components/schemas/Prison"
1905-
1868+
PrisonerOffenderSearch:
1869+
type: object
1870+
properties:
1871+
firstName:
1872+
type: string
1873+
description: First name
1874+
lastName:
1875+
type: string
1876+
description: Last name
1877+
middleName:
1878+
type: string
1879+
nullable: true
1880+
description: Middle name
1881+
dateOfBirth:
1882+
type: string
1883+
format: date
1884+
example: 1975-04-02
1885+
description: Date of birth
1886+
gender:
1887+
type: string
1888+
description: Gender
1889+
ethnicity:
1890+
type: string
1891+
description: Ethnicity
1892+
aliases:
1893+
type: array
1894+
items:
1895+
$ref: "#/components/schemas/Alias"
1896+
description: List of aliases
1897+
identifiers:
1898+
$ref: "#/components/schemas/Identifiers"
1899+
pncId:
1900+
type: string
1901+
description: An identifier from the Police National Computer (PNC)
1902+
hmppsId:
1903+
type: string
1904+
nullable: true
1905+
description: Currently a hmppsId is a CRN identifier however this will change in the future to be a new unique Hmpps identifier
1906+
contactDetails:
1907+
$ref: "#/components/schemas/ContactDetails"
1908+
ProbationOffenderSearch:
1909+
type: object
1910+
properties:
1911+
firstName:
1912+
type: string
1913+
description: First name
1914+
lastName:
1915+
type: string
1916+
description: Last name
1917+
middleName:
1918+
type: string
1919+
nullable: true
1920+
description: Middle name
1921+
dateOfBirth:
1922+
type: string
1923+
format: date
1924+
description: Date of birth
1925+
gender:
1926+
type: string
1927+
description: Gender
1928+
ethnicity:
1929+
type: string
1930+
nullable: true
1931+
description: Ethnicity
1932+
aliases:
1933+
type: array
1934+
items:
1935+
$ref: "#/components/schemas/Alias"
1936+
description: List of aliases
1937+
identifiers:
1938+
$ref: "#/components/schemas/Identifiers"
1939+
pncId:
1940+
type: string
1941+
description: An identifier from the Police National Computer (PNC)
1942+
hmppsId:
1943+
type: string
1944+
description: Hmpps identifier
1945+
contactDetails:
1946+
$ref: "#/components/schemas/ContactDetails"
19061947
Punishment:
19071948
type: object
19081949
properties:

0 commit comments

Comments
 (0)