diff --git a/obp-api/src/main/scala/code/api/v3_0_0/APIMethods300.scala b/obp-api/src/main/scala/code/api/v3_0_0/APIMethods300.scala index 1aa7d43c4..400da0234 100644 --- a/obp-api/src/main/scala/code/api/v3_0_0/APIMethods300.scala +++ b/obp-api/src/main/scala/code/api/v3_0_0/APIMethods300.scala @@ -508,25 +508,25 @@ trait APIMethods300 { "/banks/BANK_ID/firehose/accounts/views/VIEW_ID", "Get Firehose Accounts at Bank", s""" - |Get Accounts which have a firehose view assigned to them. + |Get all Accounts at a Bank. | - |This endpoint allows bulk access to accounts. + |This endpoint allows bulk access to all accounts at the specified bank. | - |Requires the CanUseFirehoseAtAnyBank Role + |Requires the CanUseFirehoseAtAnyBank Role or CanUseAccountFirehose Role | - |To be shown on the list, each Account must have a firehose View linked to it. + |Returns all accounts at the bank. The VIEW_ID parameter determines what account data fields are visible according to the view's permissions. | - |A firehose view has is_firehose = true + |The view specified must have is_firehose = true | - |For VIEW_ID try 'owner' + |For VIEW_ID try 'owner' or 'firehose' | - |optional request parameters for filter with attributes + |Optional request parameters for filtering by account attributes: |URL params example: - | /banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1 + | /banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1 | - |to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be `_timestamp_` + |To invalidate browser cache, add timestamp query parameter as follows (the parameter name must be `_timestamp_`): |URL params example: - | `/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358` + | `/banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1&_timestamp_=1596762180358` | |${userAuthenticationMessage(true)} | diff --git a/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala b/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala index 81264a54d..d85f3d265 100644 --- a/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala +++ b/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala @@ -4392,25 +4392,25 @@ trait APIMethods400 extends MdcLoggable { "/banks/BANK_ID/firehose/accounts/views/VIEW_ID", "Get Firehose Accounts at Bank", s""" - |Get Accounts which have a firehose view assigned to them. + |Get all Accounts at a Bank. | - |This endpoint allows bulk access to accounts. + |This endpoint allows bulk access to all accounts at the specified bank. | - |Requires the CanUseFirehoseAtAnyBank Role + |Requires the CanUseFirehoseAtAnyBank Role or CanUseAccountFirehose Role | - |To be shown on the list, each Account must have a firehose View linked to it. + |Returns all accounts at the bank. The VIEW_ID parameter determines what account data fields are visible according to the view's permissions. | - |A firehose view has is_firehose = true + |The view specified must have is_firehose = true | - |For VIEW_ID try 'owner' + |For VIEW_ID try 'owner' or 'firehose' | - |optional request parameters for filter with attributes + |Optional request parameters for filtering by account attributes: |URL params example: - | /banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1 + | /banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1 | - |to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be `_timestamp_` + |To invalidate browser cache, add timestamp query parameter as follows (the parameter name must be `_timestamp_`): |URL params example: - | `/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358` + | `/banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1&_timestamp_=1596762180358` | |${userAuthenticationMessage(true)} |