| commit | author | age | ||
| 5764ac | 1 | get: |
| MH | 2 | summary: Returns a list of (optionally filtered) cooperative share transactions. |
| 3 | description: Returns the list of (optionally filtered) cooperative share transactions which are visible to the current user or any of it's assumed roles. | |
| 4 | tags: | |
| 5 | - hs-office-coopShares | |
| 6 | operationId: listCoopShares | |
| 7 | parameters: | |
| 8 | - $ref: './auth.yaml#/components/parameters/currentUser' | |
| 9 | - $ref: './auth.yaml#/components/parameters/assumedRoles' | |
| 10 | - name: membershipUuid | |
| 11 | in: query | |
| 12 | required: false | |
| 13 | schema: | |
| 14 | type: string | |
| 15 | format: uuid | |
| 16 | description: Optional UUID of the related membership. | |
| 17 | - name: fromValueDate | |
| 18 | in: query | |
| 19 | required: false | |
| 20 | schema: | |
| 21 | type: string | |
| 22 | format: date | |
| 23 | description: Optional value date range start (inclusive). | |
| 24 | - name: toValueDate | |
| 25 | in: query | |
| 26 | required: false | |
| 27 | schema: | |
| 28 | type: string | |
| 29 | format: date | |
| 30 | description: Optional value date range end (inclusive). | |
| 31 | responses: | |
| 32 | "200": | |
| 33 | description: OK | |
| 34 | content: | |
| 35 | 'application/json': | |
| 36 | schema: | |
| 37 | type: array | |
| 38 | items: | |
| 39 | $ref: './hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransaction' | |
| 40 | "401": | |
| 41 | $ref: './error-responses.yaml#/components/responses/Unauthorized' | |
| 42 | "403": | |
| 43 | $ref: './error-responses.yaml#/components/responses/Forbidden' | |
| 44 | ||
| 45 | post: | |
| 46 | summary: Adds a new cooperative share transaction. | |
| 47 | tags: | |
| 48 | - hs-office-coopShares | |
| 49 | operationId: addCoopSharesTransaction | |
| 50 | parameters: | |
| 51 | - $ref: './auth.yaml#/components/parameters/currentUser' | |
| 52 | - $ref: './auth.yaml#/components/parameters/assumedRoles' | |
| 53 | requestBody: | |
| 54 | description: A JSON object describing the new cooperative shares transaction. | |
| 55 | required: true | |
| 56 | content: | |
| 57 | application/json: | |
| 58 | schema: | |
| 59 | $ref: '/hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransactionInsert' | |
| 60 | responses: | |
| 61 | "201": | |
| 62 | description: Created | |
| 63 | content: | |
| 64 | 'application/json': | |
| 65 | schema: | |
| 66 | $ref: './hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransaction' | |
| 67 | "401": | |
| 68 | $ref: './error-responses.yaml#/components/responses/Unauthorized' | |
| 69 | "403": | |
| 70 | $ref: './error-responses.yaml#/components/responses/Forbidden' | |
| 71 | "409": | |
| 72 | $ref: './error-responses.yaml#/components/responses/Conflict' | |
