@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Open Data API
@base https://developer.openbanking.org.uk/reference-implementation/open-banking/v1.3
@version v1.3
@common_fields {If-Modified-Since: any # Used for conditional request, to retrieve data only if modified since a given date, If-None-Match: any # Used for conditional request, to retrieve data only if the given Etag value does not match}
@endpoints 12
@toc branches(2), atms(2), personal-current-accounts(2), business-current-accounts(2), unsecured-sme-loans(2), commercial-credit-cards(2)

@group branches
@endpoint GET /branches
@desc Gets a list of all `Branch` objects.
@returns(200) Successful response with a list of `Branch` data
@errors {400: You have sent a request which could not be understood., 408: Your client has failed to submit a request, and a timeout has occurred., 429: You have requested this resource too often. Slow down., 500: An error occurred on the server. No further information is available., 503: The service is temporarily unavailable.}

@endpoint HEAD /branches
@desc Gets header information on the current set of `Branch` data

@endgroup

@group atms
@endpoint GET /atms
@desc Gets a list of all `ATM` objects.
@returns(200) Successful response with a list of `ATM` data
@errors {400: You have sent a request which could not be understood., 408: Your client has failed to submit a request, and a timeout has occurred., 429: You have requested this resource too often. Slow down., 500: An error occurred on the server. No further information is available., 503: The service is temporarily unavailable.}

@endpoint HEAD /atms
@desc Gets header information on the current set of `ATM` data

@endgroup

@group personal-current-accounts
@endpoint GET /personal-current-accounts
@desc Gets a list of all `Personal Current Account` objects.
@returns(200) Successful response with a list of `Personal Current Account` data
@errors {400: You have sent a request which could not be understood., 408: Your client has failed to submit a request, and a timeout has occurred., 429: You have requested this resource too often. Slow down., 500: An error occurred on the server. No further information is available., 503: The service is temporarily unavailable.}

@endpoint HEAD /personal-current-accounts
@desc Gets header information on the current set of `Personal Current Account` data

@endgroup

@group business-current-accounts
@endpoint GET /business-current-accounts
@desc Gets a list of all `Branch Current Account` objects.
@returns(200) Successful response with a list of `Branch Current Account` data
@errors {400: You have sent a request which could not be understood., 408: Your client has failed to submit a request, and a timeout has occurred., 429: You have requested this resource too often. Slow down., 500: An error occurred on the server. No further information is available., 503: The service is temporarily unavailable.}

@endpoint HEAD /business-current-accounts
@desc Gets header information on the current set of `Business Current Account` data

@endgroup

@group unsecured-sme-loans
@endpoint GET /unsecured-sme-loans
@desc Gets a list of all `Unsercured SME Lending` objects.
@returns(200) Successful response with a list of `Unsecured SME Lending` data
@errors {400: You have sent a request which could not be understood., 408: Your client has failed to submit a request, and a timeout has occurred., 429: You have requested this resource too often. Slow down., 500: An error occurred on the server. No further information is available., 503: The service is temporarily unavailable.}

@endpoint HEAD /unsecured-sme-loans
@desc Gets header information on the current set of `Unsercured SME Lending` data

@endgroup

@group commercial-credit-cards
@endpoint GET /commercial-credit-cards
@desc Gets a list of all `Commerical Credit Card` objects.
@returns(200) Successful response with a list of `Commercial Credit Card` data
@errors {400: You have sent a request which could not be understood., 408: Your client has failed to submit a request, and a timeout has occurred., 429: You have requested this resource too often. Slow down., 500: An error occurred on the server. No further information is available., 503: The service is temporarily unavailable.}

@endpoint HEAD /commercial-credit-cards
@desc Gets header information on the current set of `Commerical Credit Card` data

@endgroup

@end