Package org.apache.fineract.client.services

Interface SearchApiApi

public interface SearchApiApi

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<List<AdHocSearchQueryData>>
    advancedSearch(PostAdhocQuerySearchRequest postAdhocQuerySearchRequest)
    Adhoc query search AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters Mandatory fields:entities Optional fields:loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, minOutstandingAmount and maxOutstandingAmount OR outstandingAmount
    retrofit2.Call<List<AdHocSearchQueryData>>
    advancedSearch(PostAdhocQuerySearchRequest postAdhocQuerySearchRequest, Map<String,String> headers)
    Adhoc query search AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters Mandatory fields:entities Optional fields:loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, minOutstandingAmount and maxOutstandingAmount OR outstandingAmount
    retrofit2.Call<AdHocSearchQueryData>
    retrieveAdHocSearchQueryTemplate()
    Retrive Adhoc Search query template Mandatory Fields search?query=000000001
    retrofit2.Call<AdHocSearchQueryData>
    retrieveAdHocSearchQueryTemplate(Map<String,String> headers)
    Retrive Adhoc Search query template Mandatory Fields search?query=000000001
    retrofit2.Call<List<GetSearchResponse>>
    searchData(String query, String resource, Boolean exactMatch)
    Search Resources Example Requests: search?query=000000001 search?query=Petra&resource=clients,groups search?query=Petra&resource=clients,groups&exactMatch=true
    retrofit2.Call<List<GetSearchResponse>>
    searchData(String query, String resource, Boolean exactMatch, Map<String,String> headers)
    Search Resources Example Requests: search?query=000000001 search?query=Petra&resource=clients,groups search?query=Petra&resource=clients,groups&exactMatch=true

  • Method Details

    • advancedSearch

      @Headers("Content-Type:application/json") @POST("v1/search/advance") retrofit2.Call<List<AdHocSearchQueryData>> advancedSearch(@Body PostAdhocQuerySearchRequest postAdhocQuerySearchRequest)
      Adhoc query search AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters Mandatory fields:entities Optional fields:loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, minOutstandingAmount and maxOutstandingAmount OR outstandingAmount
      Parameters:
      postAdhocQuerySearchRequest - (required)
      Returns:
      Call<List<AdHocSearchQueryData>>

    • retrieveAdHocSearchQueryTemplate

      @GET("v1/search/template") retrofit2.Call<AdHocSearchQueryData> retrieveAdHocSearchQueryTemplate()
      Retrive Adhoc Search query template Mandatory Fields search?query=000000001
      Returns:
      Call<AdHocSearchQueryData>

    • searchData

      @GET("v1/search") retrofit2.Call<List<GetSearchResponse>> searchData(@Query("query") String query, @Query("resource") String resource, @Query("exactMatch") Boolean exactMatch)
      Search Resources Example Requests: search?query=000000001 search?query=Petra&resource=clients,groups search?query=Petra&resource=clients,groups&exactMatch=true
      Parameters:
      query - query (optional)
      resource - resource (optional)
      exactMatch - exactMatch (optional, default to false)
      Returns:
      Call<List<GetSearchResponse>>

    • advancedSearch

      @Headers("Content-Type:application/json") @POST("v1/search/advance") retrofit2.Call<List<AdHocSearchQueryData>> advancedSearch(@Body PostAdhocQuerySearchRequest postAdhocQuerySearchRequest, @HeaderMap Map<String,String> headers)
      Adhoc query search AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters Mandatory fields:entities Optional fields:loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, minOutstandingAmount and maxOutstandingAmount OR outstandingAmount
      Parameters:
      postAdhocQuerySearchRequest - (required)
      Returns:
      Call<List<AdHocSearchQueryData>>

    • retrieveAdHocSearchQueryTemplate

      @GET("v1/search/template") retrofit2.Call<AdHocSearchQueryData> retrieveAdHocSearchQueryTemplate(@HeaderMap Map<String,String> headers)
      Retrive Adhoc Search query template Mandatory Fields search?query=000000001
      Returns:
      Call<AdHocSearchQueryData>

    • searchData

      @GET("v1/search") retrofit2.Call<List<GetSearchResponse>> searchData(@Query("query") String query, @Query("resource") String resource, @Query("exactMatch") Boolean exactMatch, @HeaderMap Map<String,String> headers)
      Search Resources Example Requests: search?query=000000001 search?query=Petra&resource=clients,groups search?query=Petra&resource=clients,groups&exactMatch=true
      Parameters:
      query - query (optional)
      resource - resource (optional)
      exactMatch - exactMatch (optional, default to false)
      Returns:
      Call<List<GetSearchResponse>>