hs.hsadmin.ng/src/main/resources/api-definition/hs-office/hs-office-sepamandates.yaml
Michael Hoennig ddba946d72 add micrometer @Timing annotations to Controllers+Repositories + ArchTest (#128)
Co-authored-by: Michael Hoennig <michael@hoennig.de>
Reviewed-on: #128
Reviewed-by: Timotheus Pokorra <timotheus.pokorra@hostsharing.net>
2024-12-05 10:32:34 +01:00

58 lines
2.2 KiB
YAML

get:
summary: Returns a list of (optionally filtered) SEPA Mandates.
description: Returns the list of (optionally filtered) SEPA Mandates which are visible to the current subject or any of it's assumed roles.
tags:
- hs-office-sepaMandates
operationId: getListOfSepaMandates
parameters:
- $ref: 'auth.yaml#/components/parameters/currentSubject'
- $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: iban
in: query
required: false
schema:
type: string
description: (Beginning of) IBAN to filter the results.
responses:
"200":
description: OK
content:
'application/json':
schema:
type: array
items:
$ref: 'hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate'
"401":
$ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403":
$ref: 'error-responses.yaml#/components/responses/Forbidden'
post:
summary: Adds a new SEPA Mandate.
tags:
- hs-office-sepaMandates
operationId: postNewSepaMandate
parameters:
- $ref: 'auth.yaml#/components/parameters/currentSubject'
- $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody:
description: A JSON object describing the new SEPA-Mandate.
required: true
content:
application/json:
schema:
$ref: 'hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandateInsert'
responses:
"201":
description: Created
content:
'application/json':
schema:
$ref: 'hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate'
"401":
$ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403":
$ref: 'error-responses.yaml#/components/responses/Forbidden'
"409":
$ref: 'error-responses.yaml#/components/responses/Conflict'