Package de.adorsys.psd2.consent.aspsp.api.ais

Interface CmsAspspAisExportService

  • @NotNull
public interface CmsAspspAisExportService

    • Method Detail

      • exportConsentsByTpp

        PageData<Collection<de.adorsys.psd2.consent.api.ais.CmsAisAccountConsent>> exportConsentsByTpp​(String tppAuthorisationNumber,
                                                                                               @Nullable
                                                                                               @Nullable LocalDate createDateFrom,
                                                                                               @Nullable
                                                                                               @Nullable LocalDate createDateTo,
                                                                                               @Nullable
                                                                                               @Nullable de.adorsys.psd2.xs2a.core.psu.PsuIdData psuIdData,
                                                                                               @NotNull
                                                                                               @NotNull String instanceId,
                                                                                               @Nullable
                                                                                               @Nullable de.adorsys.psd2.xs2a.core.pagination.data.PageRequestParameters pageRequestParameters,
                                                                                               @Nullable
                                                                                               @Nullable String additionalTppInfo)
        Returns list of consents by given criteria.
        Parameters:
        tppAuthorisationNumber - Mandatory TPP ID
        createDateFrom - Optional starting creation date criteria
        createDateTo - Optional ending creation date criteria
        psuIdData - Optional Psu information criteria
        instanceId - Mandatory id of particular service instance
        pageRequestParameters - index of current page and quantity of consents on one page
        Returns:
        Collection of consents for TPP by given criteria. By inconsistent criteria an empty list will be returned
        Throws:
        TooManyResultsException - If CMS is not able to provide result due to overflow, developer shall limit his/her request, making pagination by dates.

      • exportConsentsByPsuAndAdditionalTppInfo

        PageData<Collection<de.adorsys.psd2.consent.api.ais.CmsAisAccountConsent>> exportConsentsByPsuAndAdditionalTppInfo​(de.adorsys.psd2.xs2a.core.psu.PsuIdData psuIdData,
                                                                                                                   @Nullable
                                                                                                                   @Nullable LocalDate createDateFrom,
                                                                                                                   @Nullable
                                                                                                                   @Nullable LocalDate createDateTo,
                                                                                                                   @NotNull
                                                                                                                   @NotNull String instanceId,
                                                                                                                   Integer pageIndex,
                                                                                                                   Integer itemsPerPage,
                                                                                                                   @Nullable
                                                                                                                   @Nullable String additionalTppInfo)
        Returns list of consents by given criteria.
        Parameters:
        psuIdData - Mandatory Psu information criteria
        createDateFrom - Optional starting creation date criteria
        createDateTo - Optional ending creation date criteria
        instanceId - Mandatory id of particular service instance
        pageIndex - index of current page
        itemsPerPage - quantity of consents on one page
        Returns:
        Collection of consents for PSU by given criteria. By inconsistent criteria an empty list will be returned
        Throws:
        TooManyResultsException - If CMS is not able to provide result due to overflow, developer shall limit his/her request, making pagination by dates.

      • exportConsentsByAccountIdAndAdditionalTppInfo

        PageData<Collection<de.adorsys.psd2.consent.api.ais.CmsAisAccountConsent>> exportConsentsByAccountIdAndAdditionalTppInfo​(@NotNull
                                                                                                                         @NotNull String aspspAccountId,
                                                                                                                         @Nullable
                                                                                                                         @Nullable LocalDate createDateFrom,
                                                                                                                         @Nullable
                                                                                                                         @Nullable LocalDate createDateTo,
                                                                                                                         @NotNull
                                                                                                                         @NotNull String instanceId,
                                                                                                                         Integer pageIndex,
                                                                                                                         Integer itemsPerPage,
                                                                                                                         @Nullable
                                                                                                                         @Nullable String additionalTppInfo)
        Returns list of consents by given criteria.
        Parameters:
        aspspAccountId - Bank specific account identifier
        createDateFrom - Optional starting creation date criteria
        createDateTo - Optional ending creation date criteria
        instanceId - Mandatory id of particular service instance
        pageIndex - index of current page
        itemsPerPage - quantity of consents on one page
        Returns:
        Collection of consents for PSU by given criteria. By inconsistent criteria an empty list will be returned
        Throws:
        TooManyResultsException - If CMS is not able to provide result due to overflow, developer shall limit his/her request, making pagination by dates.