hs.hsadmin.ng/src/main/resources/api-definition/hs-office/hs-office-relations.yaml

get:
    summary: Returns a list of (optionally filtered) person relations for a given person.
    description: Returns the list of (optionally filtered) person relations of a given person and which are visible to the current user or any of it's assumed roles.
    tags:
        - hs-office-relations
    operationId: listRelations
    parameters:
        - $ref: './auth.yaml#/components/parameters/currentUser'
        - $ref: './auth.yaml#/components/parameters/assumedRoles'
        - name: personUuid
          in: query
          required: true
          schema:
              type: string
              format: uuid
          description: Prefix of name properties from holder or contact to filter the results.
        - name: relationType
          in: query
          required: false
          schema:
              $ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationType'
          description: Prefix of name properties from holder or contact to filter the results.
    responses:
        "200":
            description: OK
            content:
                'application/json':
                    schema:
                        type: array
                        items:
                            $ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
        "401":
            $ref: './error-responses.yaml#/components/responses/Unauthorized'
        "403":
            $ref: './error-responses.yaml#/components/responses/Forbidden'

post:
    summary: Adds a new person relation.
    tags:
        - hs-office-relations
    operationId: addRelation
    parameters:
        - $ref: './auth.yaml#/components/parameters/currentUser'
        - $ref: './auth.yaml#/components/parameters/assumedRoles'
    requestBody:
        content:
            'application/json':
                schema:
                    $ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationInsert'
        required: true
    responses:
        "201":
            description: Created
            content:
                'application/json':
                    schema:
                        $ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
        "401":
            $ref: './error-responses.yaml#/components/responses/Unauthorized'
        "403":
            $ref: './error-responses.yaml#/components/responses/Forbidden'
        "409":
            $ref: './error-responses.yaml#/components/responses/Conflict'