Package org.apache.fineract.client.services

Interface ReportsApi

public interface ReportsApi

  • Method Details

    • createReport

      @Headers("Content-Type:application/json") @POST("v1/reports") retrofit2.Call<PostReportsResponse> createReport(@Body PostRepostRequest postRepostRequest)
      Create a Report
      Parameters:
      postRepostRequest - (required)
      Returns:
      Call<PostReportsResponse>

    • deleteReport

      @DELETE("v1/reports/{id}") retrofit2.Call<DeleteReportsResponse> deleteReport(@Path("id") Long id)
      Delete a Report Only non-core reports can be deleted.
      Parameters:
      id - id (required)
      Returns:
      Call<DeleteReportsResponse>

    • retrieveOfficeTemplate

      @GET("v1/reports/template") retrofit2.Call<GetReportsTemplateResponse> retrieveOfficeTemplate()
      Retrieve Report 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 description Lists Example Request : reports/template
      Returns:
      Call<GetReportsTemplateResponse>

    • retrieveReport

      @GET("v1/reports/{id}") retrofit2.Call<GetReportsResponse> retrieveReport(@Path("id") Long id)
      Retrieve a Report Example Requests: reports/1 reports/1?template=true
      Parameters:
      id - id (required)
      Returns:
      Call<GetReportsResponse>

    • retrieveReportList

      @GET("v1/reports") retrofit2.Call<List<GetReportsResponse>> retrieveReportList()
      List Reports Lists all reports and their parameters. Example Request: reports
      Returns:
      Call<List<GetReportsResponse>>

    • updateReport

      @Headers("Content-Type:application/json") @PUT("v1/reports/{id}") retrofit2.Call<PutReportResponse> updateReport(@Path("id") Long id, @Body PutReportRequest putReportRequest)
      Update a Report Only the useReport description can be updated for core reports.
      Parameters:
      id - id (required)
      putReportRequest - (required)
      Returns:
      Call<PutReportResponse>

    • createReport

      @Headers("Content-Type:application/json") @POST("v1/reports") retrofit2.Call<PostReportsResponse> createReport(@Body PostRepostRequest postRepostRequest, @HeaderMap Map<String,String> headers)
      Create a Report
      Parameters:
      postRepostRequest - (required)
      Returns:
      Call<PostReportsResponse>

    • deleteReport

      @DELETE("v1/reports/{id}") retrofit2.Call<DeleteReportsResponse> deleteReport(@Path("id") Long id, @HeaderMap Map<String,String> headers)
      Delete a Report Only non-core reports can be deleted.
      Parameters:
      id - id (required)
      Returns:
      Call<DeleteReportsResponse>

    • retrieveOfficeTemplate

      @GET("v1/reports/template") retrofit2.Call<GetReportsTemplateResponse> retrieveOfficeTemplate(@HeaderMap Map<String,String> headers)
      Retrieve Report 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 description Lists Example Request : reports/template
      Returns:
      Call<GetReportsTemplateResponse>

    • retrieveReport

      @GET("v1/reports/{id}") retrofit2.Call<GetReportsResponse> retrieveReport(@Path("id") Long id, @HeaderMap Map<String,String> headers)
      Retrieve a Report Example Requests: reports/1 reports/1?template=true
      Parameters:
      id - id (required)
      Returns:
      Call<GetReportsResponse>

    • retrieveReportList

      @GET("v1/reports") retrofit2.Call<List<GetReportsResponse>> retrieveReportList(@HeaderMap Map<String,String> headers)
      List Reports Lists all reports and their parameters. Example Request: reports
      Returns:
      Call<List<GetReportsResponse>>

    • updateReport

      @Headers("Content-Type:application/json") @PUT("v1/reports/{id}") retrofit2.Call<PutReportResponse> updateReport(@Path("id") Long id, @Body PutReportRequest putReportRequest, @HeaderMap Map<String,String> headers)
      Update a Report Only the useReport description can be updated for core reports.
      Parameters:
      id - id (required)
      putReportRequest - (required)
      Returns:
      Call<PutReportResponse>