Disclosure
Admin API
>
API Reference
>
v0
>
Documents
>
Disclosure
openapi: 3.0.0
info:
title: EDocs Disclosure API.
version: '0.0'
servers:
- url: 'https://banno.com'
tags:
- name: disclosures
description: Institutions Disclosures for using edocs services.
paths:
"/a/mobile/api/v0/institutions/{institutionId}/documents/disclosures":
get:
tags:
- disclosures
description: |
returns all disclosures for an institutionId
Requires the "Manage security settings" permission for People
security:
- clientCredentials: []
parameters:
- name: institutionId
in: path
description: Uuid for the institution.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Successful Request - Returns all disclosures for institution.
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/disclosure"
post:
tags:
- disclosures
description: |
Creating an institution disclosure.
Requires the "Manage security settings" permission for People
security:
- clientCredentials: []
parameters:
- name: institutionId
in: path
description: Uuid for the institution.
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/terms"
description: The terms and the user who created them.
required: true
responses:
'200':
description: Successful Response returning a disclosureId.
content:
application/json:
schema:
"$ref": "#/components/schemas/disclosureId"
components:
securitySchemes:
clientCredentials:
type: oauth2
description: OAuth2 using the client credentials flow
flows:
clientCredentials:
tokenUrl: https://banno.com/a/oidc-provider/api/v0/token
scopes: {}
schemas:
disclosureId:
type: string
format: uuid
disclosure:
type: object
description: Terms and conditions of using electronic documents.
properties:
disclosureId:
type: string
format: uuid
terms:
type: string
createdDate:
type: string
format: date-time
example: 2021-02-03T16:04:09.206766Z
createdBy:
type: string
format: uuid
description: Id of the institution user.
terms:
type: object
properties:
terms:
type: string
createdBy:
type: string
format: uuid
description: Id of the institution user.
Have a Question?
Have a how-to question? Seeing a weird error? Get help on
StackOverflow.
Register for the Digital Toolkit Meetup
where we answer technical Q&A from the audience.
Last updated Thu Jul 29 2021