Package org.apache.fineract.client.services

Interface SelfShareAccountsApi

public interface SelfShareAccountsApi

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<List<PostNewShareApplicationResponse>>
    createAccount1()
    Submit new share application Mandatory fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields accountNo, externalId Inherited from Product (if not provided) minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
    retrofit2.Call<List<PostNewShareApplicationResponse>>
    createAccount1(Map<String,String> headers)
    Submit new share application Mandatory fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields accountNo, externalId Inherited from Product (if not provided) minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
    retrofit2.Call<List<PostNewShareApplicationResponse>>
    createAccount1(AccountRequest accountRequest)
    Submit new share application Mandatory fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields accountNo, externalId Inherited from Product (if not provided) minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
    retrofit2.Call<List<PostNewShareApplicationResponse>>
    createAccount1(AccountRequest accountRequest, Map<String,String> headers)
    Submit new share application Mandatory fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields accountNo, externalId Inherited from Product (if not provided) minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
    retrofit2.Call<String>
    retrieveShareAccount(Long accountId)
    Retrieve a share application/account Example Requests: self/shareaccounts/12
    retrofit2.Call<String>
    retrieveShareAccount(Long accountId, Map<String,String> headers)
    Retrieve a share application/account Example Requests: self/shareaccounts/12
    retrofit2.Call<List<GetShareAccountsClientIdProductIdResponse>>
    template19(Long clientId, Long productId)
    Retrieve Share Account Template This is a convenience resource.
    retrofit2.Call<List<GetShareAccountsClientIdProductIdResponse>>
    template19(Long clientId, Long productId, Map<String,String> headers)
    Retrieve Share Account Template This is a convenience resource.

  • Method Details

    • createAccount1

      @Headers("Content-Type:application/json") @POST("v1/self/shareaccounts") retrofit2.Call<List<PostNewShareApplicationResponse>> createAccount1(@Body AccountRequest accountRequest)
      Submit new share application Mandatory fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields accountNo, externalId Inherited from Product (if not provided) minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
      Parameters:
      accountRequest - (optional)
      Returns:
      Call<List<PostNewShareApplicationResponse>>

    • retrieveShareAccount

      @GET("v1/self/shareaccounts/{accountId}") retrofit2.Call<String> retrieveShareAccount(@Path("accountId") Long accountId)
      Retrieve a share application/account Example Requests: self/shareaccounts/12
      Parameters:
      accountId - (required)
      Returns:
      Call<String>

    • template19

      @GET("v1/self/shareaccounts/template") retrofit2.Call<List<GetShareAccountsClientIdProductIdResponse>> template19(@Query("clientId") Long clientId, @Query("productId") Long productId)
      Retrieve Share Account Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Arguments clientId:Integer mandatory productId:Integer optionalIf entered, productId, productName and selectedProduct fields are returned. Example Requests: self/shareaccounts/template?clientId=14 self/shareaccounts/template?clientId=14&productId=3
      Parameters:
      clientId - (optional)
      productId - (optional)
      Returns:
      Call<List<GetShareAccountsClientIdProductIdResponse>>

    • createAccount1

      @Headers("Content-Type:application/json") @POST("v1/self/shareaccounts") retrofit2.Call<List<PostNewShareApplicationResponse>> createAccount1()
      Submit new share application Mandatory fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields accountNo, externalId Inherited from Product (if not provided) minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
      Parameters:
      accountRequest - (optional)
      Returns:
      Call<List<PostNewShareApplicationResponse>>

    • createAccount1

      @Headers("Content-Type:application/json") @POST("v1/self/shareaccounts") retrofit2.Call<List<PostNewShareApplicationResponse>> createAccount1(@Body AccountRequest accountRequest, @HeaderMap Map<String,String> headers)
      Submit new share application Mandatory fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields accountNo, externalId Inherited from Product (if not provided) minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
      Parameters:
      accountRequest - (optional)
      Returns:
      Call<List<PostNewShareApplicationResponse>>

    • retrieveShareAccount

      @GET("v1/self/shareaccounts/{accountId}") retrofit2.Call<String> retrieveShareAccount(@Path("accountId") Long accountId, @HeaderMap Map<String,String> headers)
      Retrieve a share application/account Example Requests: self/shareaccounts/12
      Parameters:
      accountId - (required)
      Returns:
      Call<String>

    • template19

      @GET("v1/self/shareaccounts/template") retrofit2.Call<List<GetShareAccountsClientIdProductIdResponse>> template19(@Query("clientId") Long clientId, @Query("productId") Long productId, @HeaderMap Map<String,String> headers)
      Retrieve Share Account Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Arguments clientId:Integer mandatory productId:Integer optionalIf entered, productId, productName and selectedProduct fields are returned. Example Requests: self/shareaccounts/template?clientId=14 self/shareaccounts/template?clientId=14&productId=3
      Parameters:
      clientId - (optional)
      productId - (optional)
      Returns:
      Call<List<GetShareAccountsClientIdProductIdResponse>>

    • createAccount1

      @Headers("Content-Type:application/json") @POST("v1/self/shareaccounts") retrofit2.Call<List<PostNewShareApplicationResponse>> createAccount1(@HeaderMap Map<String,String> headers)
      Submit new share application Mandatory fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields accountNo, externalId Inherited from Product (if not provided) minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
      Parameters:
      accountRequest - (optional)
      Returns:
      Call<List<PostNewShareApplicationResponse>>