Get Bank Level Dynamic OpenAPI 3.1 documentation
GET /obp/v7.0.0/banks/BANK_ID/resource-docs/API_VERSION/openapi
OBPv1.4.0-getBankLevelDynamicResourceDocsOpenAPI31 Roles: CanReadDynamicResourceDocsAtOneBank(per bank) DocumentationAPI
Returns OpenAPI 3.1 documentation for the dynamic resources of one bank: its Dynamic Entities, Dynamic Endpoints and Dynamic Resource Docs.
BANK_ID is the bank whose dynamic resources you want. Use SYS for the system level dynamic resources, the ones that belong to no bank.
API_VERSION is the version you want documentation about e.g. v7.0.0
Static endpoints belong to no bank, so this document only ever contains dynamic resources. To document every bank's dynamic resources at once, use /resource-docs/API_VERSION/openapi?content=dynamic
Query Parameters
tags - Filter by endpoint tags (comma-separated list). Empty values will return error OBP-10053
functions - Filter by function names (comma-separated list). Empty values will return error OBP-10054
locale - Language for localized documentation, e.g. ?locale=en_GB. Invalid locales will return error OBP-10041
For YAML format, use the corresponding endpoint: /banks/BANK_ID/resource-docs/API_VERSION/openapi.yaml
Note: Resource Docs are cached, TTL is 3600 seconds
Examples
https://obp-api-sandbox.nmbbank.co.tz/obp/v7.0.0/banks/SYS/resource-docs/v7.0.0/openapi https://obp-api-sandbox.nmbbank.co.tz/obp/v7.0.0/banks/BANK_ID/resource-docs/v7.0.0/openapi.yaml
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
API_VERSION:
BANK_ID: gh.29.uk
JSON response body fields (0)
Possible errors (9)
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-00027: Invalid API Version string. We could not find the version specified.
- OBP-00008: The API version you called is not enabled on this server. Please contact your API administrator or use another version.
- OBP-10041: This locale is not supported. Only the following can be used: en_GB, es_ES, ro_RO.
- OBP-10053: Invalid tags parameter. Tags cannot be empty when provided
- OBP-10054: Invalid functions parameter. Functions cannot be empty when provided
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles: