Details

openapi: 3.0.3 info: title: Consumer Forms version: "0.0" servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Consumer Authenticated Form Submissions description: Forms for authenticated users. For use in Banno Online and Banno Mobile. paths: /institutions/{institutionId}/forms/{formId}/consumer-submissions: post: tags: - Consumer Authenticated Form Submissions description: Starts a form submission tied to a consumer authenticated user. This will be created with a random new submissionId. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/forms.readwrite' parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/formId' requestBody: content: application/json: schema: $ref: '#/components/schemas/create-form-submission' required: false responses: '200': description: OK. Submits newly created SubmissionInformation. content: application/json: schema: $ref: '#/components/schemas/create-form-submission' x-codegen-request-body-name: body /institutions/{institutionId}/forms/{formId}/consumer-submissions/{submissionId}: put: tags: - Consumer Authenticated Form Submissions description: Starts a form submission tied to a consumer authenticated user. This will be created using the provided submissionId. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/forms.readwrite' parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/formId' - $ref: '#/components/parameters/submissionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/create-form-submission' required: false responses: '200': description: OK. Submits newly created SubmissionInformation. content: application/json: schema: $ref: '#/components/schemas/create-form-submission' x-codegen-request-body-name: body /institutions/{institutionId}/forms/{formId}/versions/{versionId}/consumer-submissions/{submissionId}: post: tags: - Consumer Authenticated Form Submissions description: Update and/or submit an pre-existing form submission. For a consumer authenticated user. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/forms.readwrite' parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/formId' - $ref: '#/components/parameters/versionId' - $ref: '#/components/parameters/submissionId' - $ref: '#/components/parameters/finished' - $ref: '#/components/parameters/sourceType' - $ref: '#/components/parameters/sourceId' responses: '200': description: OK. Submits newly updated Submission. Marked as unfinished unless otherwise specified. content: application/json: schema: $ref: '#/components/schemas/form-submission' '422': description: Form field validation error content: application/json: schema: $ref: '#/components/schemas/form-submission-validation-failure' '/institutions/{institutionId}/libraries/self-service/forms': get: tags: - Form Libraries description: Retrieves a list of forms for self-service. security: - clientCredentials: [ https://jackhenry.com/forms/forms.read ] parameters: - $ref: '#/components/parameters/institutionId' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/form' components: securitySchemes: OpenID_Connect: type: openIdConnect description: OpenID Connect - Discovery endpoint will be institution specific openIdConnectUrl: >- https://digital.garden-fi.com/a/consumer/api/v0/oidc/.well-known/openid-configuration schemas: create-form-submission: type: object properties: formId: type: string format: uuid versionId: type: string format: uuid submissionId: type: string format: uuid entryId: type: string description: (deprecated, duplicate of submissionId) blocks: type: array items: $ref: '#/components/schemas/block' example: formId: 5383faae-b569-11e5-9e19-56e107cbb805 versionId: 5383fab1-b569-11e5-9e19-56e107cbb805 submissionId: 5383fab1-b569-11e5-9e19-56e107cbb805 entryId: (deprecated, duplicate of submissionId) blocks: - firstName: name: firstName label: First Name validator: {} placeholder: First Name PH middleName: name: middleName label: Middle Name validator: {} placeholder: Middle Name PH lastName: name: lastName label: Last Name validator: {} placeholder: Last Name PH options: name: efdde3b5-d022-11e5-8ab8-56e107cbb801 css: name-class description: block description blockOf: NameBlock form-entry: type: object properties: submissionId: type: string format: uuid versionId: type: string format: uuid timestamp: type: string format: date-time finished: type: boolean example: false ip: type: string referrer: type: string profileId: type: string deletedOn: type: string format: date-time block: type: object properties: identifier: $ref: '#/components/schemas/identifier' value: type: array items: type: string example: value blockOf: type: string example: nameBlock contextOf: type: string example: primary identifier: type: object properties: blockName: type: string description: Block Name example: NameBlock1 fieldName: type: string example: firstName form-submission-validation-failure: type: array items: type: object properties: identifier: $ref: '#/components/schemas/identifier' failures: type: array items: type: string description: Reason(s) why this particular Field failed to validate example: Phone number does not have enough digits form-submission: type: object properties: submission: $ref: '#/components/schemas/form-entry' data: type: array items: $ref: '#/components/schemas/block' form: type: object properties: formId: type: string format: uuid institutionId: type: string format: uuid versionId: type: string format: uuid name: type: string example: Form Name priorityLevel: type: string example: medium status: type: string example: approved lastUpdated: type: string format: date-time lastUpdatedBy: type: string format: uuid endUserNotifications: type: object properties: emailAutoResponse: type: string institutionNotifications: type: object properties: includeData: type: boolean example: false institutionGroup: type: string format: uuid emailAddresses: type: array items: type: string format: email purgeAfter: type: object properties: numberOf: type: integer timeUnit: type: string example: never blockLayout: type: object properties: blocks: type: array items: $ref: '#/components/schemas/block' form: type: object properties: formId: type: string description: Returned with or without authentication. format: uuid name: type: string description: Returned with or without Authentication. example: Form Name institutionId: type: string description: Requires authentication. format: uuid versionId: type: string description: Requires authentication. format: uuid priorityLevel: type: string description: Requires authentication. status: type: string description: Requires authentication. lastUpdated: type: string description: Requires authentication. format: date-time lastUpdatedBy: type: string description: Requires authentication. format: uuid endUserNotifications: type: object properties: emailAutoResponse: type: object properties: subject: type: string from: type: string format: email text: type: string description: Plaintext of the message. description: Requires authentication. institutionNotifications: type: object properties: includeData: type: boolean institutionGroup: type: string format: uuid emailAddresses: type: array items: type: string format: email description: Requires authentication. purgeAfter: type: object properties: numberOf: type: integer timeUnit: type: string description: Requires authentication. blockLayout: type: object properties: blocks: type: array items: $ref: '#/components/schemas/block' description: Requires authentication. description: >- Note that the `options.name` values must be unique across all blocks for that form; a recommended naming scheme is something like `textBlock1`, `numberBlock1`, `textBlock2`, etc. example: formId: 97b31e33-b62d-11e5-ba68-56e107cbb805 institutionId: a2912f3a-17e1-4327-84ae-42a887157a52 versionId: 97b31e3c-b62d-11e5-ba68-56e107cbb805 name: Form Name priorityLevel: medium status: approved lastUpdated: '2016-01-08T17:31:03.955Z' lastUpdatedBy: 97b31e3d-b62d-11e5-ba68-56e107cbb805 endUserNotifications: emailAutoResponse: subject: email subject from: someone@example.com text: |- This is the plaintext of the message. Second paragraph institutionNotifications: includeData: false institutionGroup: d30771df-468d-4a06-ad3c-4b4952946662 emailAddresses: [ ] purgeAfter: numberOf: 0 timeUnit: never blockLayout: blocks: [ ] parameters: institutionId: name: institutionId in: path description: Institution ID required: true schema: type: string format: uuid formId: name: formId in: path description: Unique ID used to identify a single form type, but not a particular submission. required: true schema: type: string format: uuid versionId: name: versionId in: path description: Unique ID to identify a specific version of a form, but not a particular submission. required: true schema: type: string format: uuid submissionId: name: submissionId in: path description: Unique ID to identify a User's draft or finalized version of a specific Form. required: true schema: type: string format: uuid finished: name: finished in: query description: Indicates whether the form is still a draft or has been finalized (submitted). `false` for starting a form or saving a draft. `true` to submit the form. required: false schema: type: boolean default: false sourceType: name: sourceType in: query description: Source type required: true schema: type: string sourceId: name: sourceId in: query description: Source ID required: true schema: type: string