Offline Status

openapi: 3.0.0 info: description: >- This service allows for getting and setting whether an FI's Core is Online or Offline. version: 1.0.0 title: Offline Status contact: name: team-discovery servers: - url: 'https://banno.com' tags: - name: Offline Status paths: '/a/offline-status/api/v0/institutions/{institutionId}/history': get: summary: >- Get entire history of offline status and messages, namely who, what value, and when. description: Requires the "View" permission for People security: - clientCredentials: [] tags: - Offline Status parameters: - name: institutionId in: path required: true description: Banno Institution ID schema: $ref: '#/components/schemas/InstitutionId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetHistoryResponse_V1' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Internal Service Error '/a/offline-status/api/v0/institutions/{institutionId}/status': post: summary: Set offline status of an institution's core. description: Requires the "Manage security settings" permission security: - clientCredentials: [] tags: - Offline Status parameters: - name: institutionId in: path required: true description: Banno Institution ID schema: $ref: '#/components/schemas/InstitutionId' responses: '204': description: NoContent '400': description: HTTP Request's payload does not match JSON contract. '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Internal Service Error requestBody: content: application/json: schema: $ref: '#/components/schemas/PostStatusRequest_V1' required: true 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: GetStatusHistory_V1: type: array description: The results will be sorted by 'appliedAt' in descending order. items: type: object required: - enterpriseUserId - status - appliedAt properties: enterpriseUserId: $ref: '#/components/schemas/EnterpriseUserId' status: $ref: '#/components/schemas/OfflineStatus' appliedAt: description: The time at which the setting was applied type: string format: date-time GetMessageHistory_V1: type: array description: The results will be sorted by 'appliedAt' in descending order. items: type: object required: - enterpriseUserId - message - appliedAt properties: enterpriseUserId: $ref: '#/components/schemas/EnterpriseUserId' message: $ref: '#/components/schemas/Message' appliedAt: description: The time at which the setting was applied type: string format: date-time InstitutionId: type: string format: uuid description: A FI's Banno UUID. EnterpriseUserId: type: string format: uuid description: A banno enterprise user. OfflineStatus: type: string enum: - offline - online - showMessage Message: type: string description: >- Message to be displayed to users in Banno Online, e.g. a banner view, when the core is offline. PostStatusRequest_V1: type: object required: - enterpriseUserId - status properties: enterpriseUserId: $ref: '#/components/schemas/EnterpriseUserId' status: $ref: '#/components/schemas/OfflineStatus' GetHistoryResponse_V1: type: object required: - statuses - messages properties: statuses: $ref: '#/components/schemas/GetStatusHistory_V1' messages: $ref: '#/components/schemas/GetMessageHistory_V1'