hs.hsadmin.ng/src/main/resources/api-definition/hs-office/hs-office-person-schemas.yaml
2022-09-21 09:44:09 +02:00

64 lines
1.9 KiB
YAML

components:
schemas:
HsOfficePersonTypeValues:
- NATURAL # a human
- LEGAL # e.g. Corp., Inc., AG, GmbH, eG
- SOLE_REPRESENTATION # e.g. OHG, GbR
- JOINT_REPRESENTATION # e.g. community of heirs
HsOfficePersonType:
type: string
enum:
- NATURAL # a human
- LEGAL # e.g. Corp., Inc., AG, GmbH, eG
- SOLE_REPRESENTATION # e.g. OHG, GbR
- JOINT_REPRESENTATION # e.g. community of heirs
HsOfficePerson:
type: object
properties:
uuid:
type: string
format: uuid
personType:
$ref: '#/components/schemas/HsOfficePersonType'
tradeName:
type: string
givenName:
type: string
familyName:
type: string
HsOfficePersonInsert:
type: object
properties:
personType:
$ref: '#/components/schemas/HsOfficePersonType'
tradeName:
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
givenName:
type: string
nullable: true
familyName:
type: string
nullable: true