Package org.apache.fineract.client.services

Interface DataTablesApi

public interface DataTablesApi

  • Method Details

    • advancedQuery

      @Headers("Content-Type:application/json") @POST("v1/datatables/{datatable}/query") retrofit2.Call<String> advancedQuery(@Path("datatable") String datatable, @Body PagedLocalRequestAdvancedQueryData pagedLocalRequestAdvancedQueryData)
      Query Data Table values Query values from a registered data table.
      Parameters:
      datatable - datatable (required)
      pagedLocalRequestAdvancedQueryData - (optional)
      Returns:
      Call<String>

    • createDatatable

      @Headers("Content-Type:application/json") @POST("v1/datatables") retrofit2.Call<PostDataTablesResponse> createDatatable(@Body PostDataTablesRequest postDataTablesRequest)
      Create Data Table Create a new data table and registers it with the Apache Fineract Core application table. Field Descriptions Mandatory - datatableName : The name of the Data Table. Mandatory - apptableName Application table name. Must be one of the following: m_client m_group m_loan m_office m_saving_account m_product_loan m_savings_product Mandatory - columns An array of columns in the new Data Table. Optional - multiRow Allows to create multiple entries in the Data Table. Optional, defaults to false. If this property is not provided Data Table will allow only one entry. Field Descriptions - columns Mandatory - name Name of the created column. Can contain only alphanumeric characters, underscores and spaces, but cannot start with a number. Cannot start or end with an underscore or space. Mandatory - type Column type. Must be one of the following: Boolean Date DateTime Decimal Dropdown Number String Text Mandatory [type = Dropdown] - code Used in Code description fields. Column name becomes: code_cd_name. Mandatory if using type Dropdown, otherwise an error is returned. Optional - mandatory Determines whether this column must have a value in every entry. Optional, defaults to false. Mandatory [type = String] - length Length of the text field. Mandatory if type String is used, otherwise an error is returned.
      Parameters:
      postDataTablesRequest - (required)
      Returns:
      Call<PostDataTablesResponse>

    • createDatatableEntry

      @Headers("Content-Type:application/json") @POST("v1/datatables/{datatable}/{apptableId}") retrofit2.Call<PostDataTablesAppTableIdResponse> createDatatableEntry(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Body String body)
      Create Entry in Data Table Adds a row to the data table. Note that the default datatable UI functionality converts any field name containing spaces to underscores when using the API. This means the field name \"Business Description\" is considered the same as \"Business_Description\". So you shouldn't have both \"versions\" in any data table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      body - { \"BusinessDescription\": \"Livestock sales\", \"Comment\": \"First comment made\", \"Education_cv\": \"Primary\", \"Gender_cd\": 6, \"HighestRatePaid\": 8.5, \"NextVisit\": \"01 October 2012\", \"YearsinBusiness\": 5, \"dateFormat\": \"dd MMMM yyyy\", \"locale\": \"en\" } (required)
      Returns:
      Call<PostDataTablesAppTableIdResponse>

    • deleteDatatable

      @DELETE("v1/datatables/{datatableName}") retrofit2.Call<DeleteDataTablesResponse> deleteDatatable(@Path("datatableName") String datatableName)
      Delete Data Table Deletes a data table and deregisters it from the Apache Fineract Core application table.
      Parameters:
      datatableName - datatableName (required)
      Returns:
      Call<DeleteDataTablesResponse>

    • deleteDatatableEntries

      @DELETE("v1/datatables/{datatable}/{apptableId}") retrofit2.Call<DeleteDataTablesDatatableAppTableIdResponse> deleteDatatableEntries(@Path("datatable") String datatable, @Path("apptableId") Long apptableId)
      Delete Entry(s) in Data Table Deletes the entry (if it exists) for data tables that are one-to-one with the application table. Deletes the entries (if they exist) for data tables that are one-to-many with the application table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      Returns:
      Call<DeleteDataTablesDatatableAppTableIdResponse>

    • deleteDatatableEntry

      @DELETE("v1/datatables/{datatable}/{apptableId}/{datatableId}") retrofit2.Call<DeleteDataTablesDatatableAppTableIdDatatableIdResponse> deleteDatatableEntry(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Path("datatableId") Long datatableId)
      Delete Entry in Datatable (One to Many) Deletes the entry (if it exists) for data tables that are one to many with the application table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      datatableId - datatableId (required)
      Returns:
      Call<DeleteDataTablesDatatableAppTableIdDatatableIdResponse>

    • deregisterDatatable

      @POST("v1/datatables/deregister/{datatable}") retrofit2.Call<PutDataTablesResponse> deregisterDatatable(@Path("datatable") String datatable)
      Deregister Data Table Deregisters a data table. It will no longer be available through the API.
      Parameters:
      datatable - datatable (required)
      Returns:
      Call<PutDataTablesResponse>

    • getDatatable

      @GET("v1/datatables/{datatable}") retrofit2.Call<GetDataTablesResponse> getDatatable(@Path("datatable") String datatable)
      Retrieve Data Table Details Lists a registered data table details and the Apache Fineract Core application table they are registered to.
      Parameters:
      datatable - datatable (required)
      Returns:
      Call<GetDataTablesResponse>

    • getDatatable1

      @GET("v1/datatables/{datatable}/{apptableId}") retrofit2.Call<String> getDatatable1(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Query("order") String order)
      Retrieve Entry(s) from Data Table Gets the entry (if it exists) for data tables that are one to one with the application table. Gets the entries (if they exist) for data tables that are one to many with the application table. Note: The 'fields' parameter is not available for datatables. ARGUMENTS orderoptional Specifies the order in which data is returned.genericResultSetoptional, defaults to false If 'true' an optimised JSON format is returned suitable for tabular display of data. This format is used by the default data tables UI functionality. Example Requests: datatables/extra_client_details/1 datatables/extra_family_details/1?order=`Date of Birth` desc datatables/extra_client_details/1?genericResultSet=true
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      order - order (optional)
      Returns:
      Call<String>

    • getDatatableManyEntry

      @GET("v1/datatables/{datatable}/{apptableId}/{datatableId}") retrofit2.Call<String> getDatatableManyEntry(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Path("datatableId") Long datatableId, @Query("order") String order, @Query("genericResultSet") Boolean genericResultSet)
      Parameters:
      datatable - (required)
      apptableId - (required)
      datatableId - (required)
      order - (optional)
      genericResultSet - Optional flag to format the response (optional, default to false)
      Returns:
      Call<String>

    • getDatatables

      @GET("v1/datatables") retrofit2.Call<List<GetDataTablesResponse>> getDatatables(@Query("apptable") String apptable)
      List Data Tables Lists registered data tables and the Apache Fineract Core application table they are registered to. ARGUMENTS apptable - optional The Apache Fineract core application table. Example Requests: datatables?apptable=m_client datatables
      Parameters:
      apptable - apptable (optional)
      Returns:
      Call<List<GetDataTablesResponse>>

    • queryValues

      @GET("v1/datatables/{datatable}/query") retrofit2.Call<String> queryValues(@Path("datatable") String datatable, @Query("columnFilter") String columnFilter, @Query("valueFilter") String valueFilter, @Query("resultColumns") String resultColumns)
      Query Data Table values Query values from a registered data table.
      Parameters:
      datatable - datatable (required)
      columnFilter - columnFilter (optional)
      valueFilter - valueFilter (optional)
      resultColumns - resultColumns (optional)
      Returns:
      Call<String>

    • registerDatatable

      @Headers("Content-Type:application/json") @POST("v1/datatables/register/{datatable}/{apptable}") retrofit2.Call<PutDataTablesResponse> registerDatatable(@Path("datatable") String datatable, @Path("apptable") String apptable, @Body Object body)
      Register Data Table Registers a data table with the Apache Fineract Core application table. This allows the data table to be maintained through the API. In case the datatable is a PPI (survey table), a parameter category should be pass along with the request. The API currently support one category (200)
      Parameters:
      datatable - datatable (required)
      apptable - apptable (required)
      body - (optional)
      Returns:
      Call<PutDataTablesResponse>

    • updateDatatable

      @Headers("Content-Type:application/json") @PUT("v1/datatables/{datatableName}") retrofit2.Call<PutDataTablesResponse> updateDatatable(@Path("datatableName") String datatableName, @Body PutDataTablesRequest putDataTablesRequest)
      Update Data Table Modifies fields of a data table. If the apptableName parameter is passed, data table is deregistered and registered with the new application table.
      Parameters:
      datatableName - datatableName (required)
      putDataTablesRequest - (required)
      Returns:
      Call<PutDataTablesResponse>

    • updateDatatableEntryOneToMany

      @Headers("Content-Type:application/json") @PUT("v1/datatables/{datatable}/{apptableId}/{datatableId}") retrofit2.Call<PutDataTablesAppTableIdDatatableIdResponse> updateDatatableEntryOneToMany(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Path("datatableId") Long datatableId, @Body String body)
      Update Entry in Data Table (One to Many) Updates the row (if it exists) of the data table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      datatableId - datatableId (required)
      body - (required)
      Returns:
      Call<PutDataTablesAppTableIdDatatableIdResponse>

    • updateDatatableEntryOnetoOne

      @Headers("Content-Type:application/json") @PUT("v1/datatables/{datatable}/{apptableId}") retrofit2.Call<PutDataTablesAppTableIdResponse> updateDatatableEntryOnetoOne(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Body String body)
      Update Entry in Data Table (One to One) Updates the row (if it exists) of the data table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      body - (required)
      Returns:
      Call<PutDataTablesAppTableIdResponse>

    • advancedQuery

      @Headers("Content-Type:application/json") @POST("v1/datatables/{datatable}/query") retrofit2.Call<String> advancedQuery(@Path("datatable") String datatable)
      Query Data Table values Query values from a registered data table.
      Parameters:
      datatable - datatable (required)
      pagedLocalRequestAdvancedQueryData - (optional)
      Returns:
      Call<String>

    • registerDatatable

      @Headers("Content-Type:application/json") @POST("v1/datatables/register/{datatable}/{apptable}") retrofit2.Call<PutDataTablesResponse> registerDatatable(@Path("datatable") String datatable, @Path("apptable") String apptable)
      Register Data Table Registers a data table with the Apache Fineract Core application table. This allows the data table to be maintained through the API. In case the datatable is a PPI (survey table), a parameter category should be pass along with the request. The API currently support one category (200)
      Parameters:
      datatable - datatable (required)
      apptable - apptable (required)
      body - (optional)
      Returns:
      Call<PutDataTablesResponse>

    • advancedQuery

      @Headers("Content-Type:application/json") @POST("v1/datatables/{datatable}/query") retrofit2.Call<String> advancedQuery(@Path("datatable") String datatable, @Body PagedLocalRequestAdvancedQueryData pagedLocalRequestAdvancedQueryData, @HeaderMap Map<String,String> headers)
      Query Data Table values Query values from a registered data table.
      Parameters:
      datatable - datatable (required)
      pagedLocalRequestAdvancedQueryData - (optional)
      Returns:
      Call<String>

    • createDatatable

      @Headers("Content-Type:application/json") @POST("v1/datatables") retrofit2.Call<PostDataTablesResponse> createDatatable(@Body PostDataTablesRequest postDataTablesRequest, @HeaderMap Map<String,String> headers)
      Create Data Table Create a new data table and registers it with the Apache Fineract Core application table. Field Descriptions Mandatory - datatableName : The name of the Data Table. Mandatory - apptableName Application table name. Must be one of the following: m_client m_group m_loan m_office m_saving_account m_product_loan m_savings_product Mandatory - columns An array of columns in the new Data Table. Optional - multiRow Allows to create multiple entries in the Data Table. Optional, defaults to false. If this property is not provided Data Table will allow only one entry. Field Descriptions - columns Mandatory - name Name of the created column. Can contain only alphanumeric characters, underscores and spaces, but cannot start with a number. Cannot start or end with an underscore or space. Mandatory - type Column type. Must be one of the following: Boolean Date DateTime Decimal Dropdown Number String Text Mandatory [type = Dropdown] - code Used in Code description fields. Column name becomes: code_cd_name. Mandatory if using type Dropdown, otherwise an error is returned. Optional - mandatory Determines whether this column must have a value in every entry. Optional, defaults to false. Mandatory [type = String] - length Length of the text field. Mandatory if type String is used, otherwise an error is returned.
      Parameters:
      postDataTablesRequest - (required)
      Returns:
      Call<PostDataTablesResponse>

    • createDatatableEntry

      @Headers("Content-Type:application/json") @POST("v1/datatables/{datatable}/{apptableId}") retrofit2.Call<PostDataTablesAppTableIdResponse> createDatatableEntry(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Body String body, @HeaderMap Map<String,String> headers)
      Create Entry in Data Table Adds a row to the data table. Note that the default datatable UI functionality converts any field name containing spaces to underscores when using the API. This means the field name \"Business Description\" is considered the same as \"Business_Description\". So you shouldn't have both \"versions\" in any data table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      body - { \"BusinessDescription\": \"Livestock sales\", \"Comment\": \"First comment made\", \"Education_cv\": \"Primary\", \"Gender_cd\": 6, \"HighestRatePaid\": 8.5, \"NextVisit\": \"01 October 2012\", \"YearsinBusiness\": 5, \"dateFormat\": \"dd MMMM yyyy\", \"locale\": \"en\" } (required)
      Returns:
      Call<PostDataTablesAppTableIdResponse>

    • deleteDatatable

      @DELETE("v1/datatables/{datatableName}") retrofit2.Call<DeleteDataTablesResponse> deleteDatatable(@Path("datatableName") String datatableName, @HeaderMap Map<String,String> headers)
      Delete Data Table Deletes a data table and deregisters it from the Apache Fineract Core application table.
      Parameters:
      datatableName - datatableName (required)
      Returns:
      Call<DeleteDataTablesResponse>

    • deleteDatatableEntries

      @DELETE("v1/datatables/{datatable}/{apptableId}") retrofit2.Call<DeleteDataTablesDatatableAppTableIdResponse> deleteDatatableEntries(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @HeaderMap Map<String,String> headers)
      Delete Entry(s) in Data Table Deletes the entry (if it exists) for data tables that are one-to-one with the application table. Deletes the entries (if they exist) for data tables that are one-to-many with the application table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      Returns:
      Call<DeleteDataTablesDatatableAppTableIdResponse>

    • deleteDatatableEntry

      @DELETE("v1/datatables/{datatable}/{apptableId}/{datatableId}") retrofit2.Call<DeleteDataTablesDatatableAppTableIdDatatableIdResponse> deleteDatatableEntry(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Path("datatableId") Long datatableId, @HeaderMap Map<String,String> headers)
      Delete Entry in Datatable (One to Many) Deletes the entry (if it exists) for data tables that are one to many with the application table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      datatableId - datatableId (required)
      Returns:
      Call<DeleteDataTablesDatatableAppTableIdDatatableIdResponse>

    • deregisterDatatable

      @POST("v1/datatables/deregister/{datatable}") retrofit2.Call<PutDataTablesResponse> deregisterDatatable(@Path("datatable") String datatable, @HeaderMap Map<String,String> headers)
      Deregister Data Table Deregisters a data table. It will no longer be available through the API.
      Parameters:
      datatable - datatable (required)
      Returns:
      Call<PutDataTablesResponse>

    • getDatatable

      @GET("v1/datatables/{datatable}") retrofit2.Call<GetDataTablesResponse> getDatatable(@Path("datatable") String datatable, @HeaderMap Map<String,String> headers)
      Retrieve Data Table Details Lists a registered data table details and the Apache Fineract Core application table they are registered to.
      Parameters:
      datatable - datatable (required)
      Returns:
      Call<GetDataTablesResponse>

    • getDatatable1

      @GET("v1/datatables/{datatable}/{apptableId}") retrofit2.Call<String> getDatatable1(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Query("order") String order, @HeaderMap Map<String,String> headers)
      Retrieve Entry(s) from Data Table Gets the entry (if it exists) for data tables that are one to one with the application table. Gets the entries (if they exist) for data tables that are one to many with the application table. Note: The 'fields' parameter is not available for datatables. ARGUMENTS orderoptional Specifies the order in which data is returned.genericResultSetoptional, defaults to false If 'true' an optimised JSON format is returned suitable for tabular display of data. This format is used by the default data tables UI functionality. Example Requests: datatables/extra_client_details/1 datatables/extra_family_details/1?order=`Date of Birth` desc datatables/extra_client_details/1?genericResultSet=true
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      order - order (optional)
      Returns:
      Call<String>

    • getDatatableManyEntry

      @GET("v1/datatables/{datatable}/{apptableId}/{datatableId}") retrofit2.Call<String> getDatatableManyEntry(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Path("datatableId") Long datatableId, @Query("order") String order, @Query("genericResultSet") Boolean genericResultSet, @HeaderMap Map<String,String> headers)
      Parameters:
      datatable - (required)
      apptableId - (required)
      datatableId - (required)
      order - (optional)
      genericResultSet - Optional flag to format the response (optional, default to false)
      Returns:
      Call<String>

    • getDatatables

      @GET("v1/datatables") retrofit2.Call<List<GetDataTablesResponse>> getDatatables(@Query("apptable") String apptable, @HeaderMap Map<String,String> headers)
      List Data Tables Lists registered data tables and the Apache Fineract Core application table they are registered to. ARGUMENTS apptable - optional The Apache Fineract core application table. Example Requests: datatables?apptable=m_client datatables
      Parameters:
      apptable - apptable (optional)
      Returns:
      Call<List<GetDataTablesResponse>>

    • queryValues

      @GET("v1/datatables/{datatable}/query") retrofit2.Call<String> queryValues(@Path("datatable") String datatable, @Query("columnFilter") String columnFilter, @Query("valueFilter") String valueFilter, @Query("resultColumns") String resultColumns, @HeaderMap Map<String,String> headers)
      Query Data Table values Query values from a registered data table.
      Parameters:
      datatable - datatable (required)
      columnFilter - columnFilter (optional)
      valueFilter - valueFilter (optional)
      resultColumns - resultColumns (optional)
      Returns:
      Call<String>

    • registerDatatable

      @Headers("Content-Type:application/json") @POST("v1/datatables/register/{datatable}/{apptable}") retrofit2.Call<PutDataTablesResponse> registerDatatable(@Path("datatable") String datatable, @Path("apptable") String apptable, @Body Object body, @HeaderMap Map<String,String> headers)
      Register Data Table Registers a data table with the Apache Fineract Core application table. This allows the data table to be maintained through the API. In case the datatable is a PPI (survey table), a parameter category should be pass along with the request. The API currently support one category (200)
      Parameters:
      datatable - datatable (required)
      apptable - apptable (required)
      body - (optional)
      Returns:
      Call<PutDataTablesResponse>

    • updateDatatable

      @Headers("Content-Type:application/json") @PUT("v1/datatables/{datatableName}") retrofit2.Call<PutDataTablesResponse> updateDatatable(@Path("datatableName") String datatableName, @Body PutDataTablesRequest putDataTablesRequest, @HeaderMap Map<String,String> headers)
      Update Data Table Modifies fields of a data table. If the apptableName parameter is passed, data table is deregistered and registered with the new application table.
      Parameters:
      datatableName - datatableName (required)
      putDataTablesRequest - (required)
      Returns:
      Call<PutDataTablesResponse>

    • updateDatatableEntryOneToMany

      @Headers("Content-Type:application/json") @PUT("v1/datatables/{datatable}/{apptableId}/{datatableId}") retrofit2.Call<PutDataTablesAppTableIdDatatableIdResponse> updateDatatableEntryOneToMany(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Path("datatableId") Long datatableId, @Body String body, @HeaderMap Map<String,String> headers)
      Update Entry in Data Table (One to Many) Updates the row (if it exists) of the data table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      datatableId - datatableId (required)
      body - (required)
      Returns:
      Call<PutDataTablesAppTableIdDatatableIdResponse>

    • updateDatatableEntryOnetoOne

      @Headers("Content-Type:application/json") @PUT("v1/datatables/{datatable}/{apptableId}") retrofit2.Call<PutDataTablesAppTableIdResponse> updateDatatableEntryOnetoOne(@Path("datatable") String datatable, @Path("apptableId") Long apptableId, @Body String body, @HeaderMap Map<String,String> headers)
      Update Entry in Data Table (One to One) Updates the row (if it exists) of the data table.
      Parameters:
      datatable - datatable (required)
      apptableId - apptableId (required)
      body - (required)
      Returns:
      Call<PutDataTablesAppTableIdResponse>

    • advancedQuery

      @Headers("Content-Type:application/json") @POST("v1/datatables/{datatable}/query") retrofit2.Call<String> advancedQuery(@Path("datatable") String datatable, @HeaderMap Map<String,String> headers)
      Query Data Table values Query values from a registered data table.
      Parameters:
      datatable - datatable (required)
      pagedLocalRequestAdvancedQueryData - (optional)
      Returns:
      Call<String>

    • registerDatatable

      @Headers("Content-Type:application/json") @POST("v1/datatables/register/{datatable}/{apptable}") retrofit2.Call<PutDataTablesResponse> registerDatatable(@Path("datatable") String datatable, @Path("apptable") String apptable, @HeaderMap Map<String,String> headers)
      Register Data Table Registers a data table with the Apache Fineract Core application table. This allows the data table to be maintained through the API. In case the datatable is a PPI (survey table), a parameter category should be pass along with the request. The API currently support one category (200)
      Parameters:
      datatable - datatable (required)
      apptable - apptable (required)
      body - (optional)
      Returns:
      Call<PutDataTablesResponse>