hs.hsadmin.ng/src/main/resources/api-definition/hs-office/hs-office-person-schemas.yaml
2024-03-18 15:40:48 +01:00

74 lines
2.0 KiB
YAML

components:
schemas:
HsOfficePersonType:
type: string
enum:
- UNKNOWN_PERSON
- NATURAL_PERSON
- LEGAL_PERSON
- INCORPORATED_FIRM
- UNINCORPORATED_FIRM
- PUBLIC_INSTITUTION
HsOfficePerson:
type: object
properties:
uuid:
type: string
format: uuid
personType:
$ref: '#/components/schemas/HsOfficePersonType'
tradeName:
type: string
salutation:
type: string
title:
type: string
givenName:
type: string
familyName:
type: string
HsOfficePersonInsert:
type: object
properties:
personType:
$ref: '#/components/schemas/HsOfficePersonType'
tradeName:
type: string
salutation:
type: string
title:
type: string
givenName:
type: string
familyName:
type: string
required:
- personType
HsOfficePersonPatch:
type: object
properties:
personType:
nullable: true
$ref: '#/components/schemas/HsOfficePersonType'
tradeName:
type: string
nullable: true
salutation:
type: string
nullable: true
title:
type: string
nullable: true
givenName:
type: string
nullable: true
familyName:
type: string
nullable: true