Package org.apache.fineract.client.services

Interface CentersApi

public interface CentersApi

  • Method Details

    • activate2

      @Headers("Content-Type:application/json") @POST("v1/centers/{centerId}") retrofit2.Call<PostCentersCenterIdResponse> activate2(@Path("centerId") Long centerId, @Body PostCentersCenterIdRequest postCentersCenterIdRequest, @Query("command") String command)
      Activate a Center | Generate Collection Sheet | Save Collection Sheet | Close a Center | Associate Groups | Disassociate Groups Activate a Center: Centers can be created in a Pending state. This API exists to enable center activation. If the center happens to be already active, this API will result in an error. Close a Center: Centers can be closed if they don't have any non-closed groups or saving accounts. If the Center has any active groups or savings accounts, this API will result in an error. Associate Groups: This API allows associating existing groups to a center. The groups are listed from the office to which the center is associated. If group(s) is already associated with a center, this API will result in an error. Disassociate Groups: This API allows to disassociate groups from a center. Generate Collection Sheet: This Api retrieves repayment details of all jlg loans under a center as on a specified meeting date. Save Collection Sheet: This Api allows the loan officer to perform bulk repayments of JLG loans for a center on a given meeting date. Showing Request/Response for Close a Center
      Parameters:
      centerId - centerId (required)
      postCentersCenterIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostCentersCenterIdResponse>

    • create7

      @Headers("Content-Type:application/json") @POST("v1/centers") retrofit2.Call<PostCentersResponse> create7(@Body PostCentersRequest postCentersRequest)
      Create a Center Creates a Center Mandatory Fields: name, officeId, active, activationDate (if active=true) Optional Fields: externalId, staffId, groupMembers
      Parameters:
      postCentersRequest - (required)
      Returns:
      Call<PostCentersResponse>

    • delete10

      @DELETE("v1/centers/{centerId}") retrofit2.Call<DeleteCentersCenterIdResponse> delete10(@Path("centerId") Long centerId)
      Delete a Center A Center can be deleted if it is in pending state and has no association - groups, loans or savings
      Parameters:
      centerId - centerId (required)
      Returns:
      Call<DeleteCentersCenterIdResponse>

    • getCentersTemplate

      @GET("v1/centers/downloadtemplate") retrofit2.Call<Void> getCentersTemplate(@Query("officeId") Long officeId, @Query("staffId") Long staffId, @Query("dateFormat") String dateFormat)
      Parameters:
      officeId - (optional)
      staffId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • postCentersTemplate

      @Multipart @POST("v1/centers/uploadtemplate") retrofit2.Call<String> postCentersTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • retrieveAll23

      @GET("v1/centers") retrofit2.Call<GetCentersResponse> retrieveAll23(@Query("officeId") Long officeId, @Query("staffId") Long staffId, @Query("externalId") String externalId, @Query("name") String name, @Query("underHierarchy") String underHierarchy, @Query("paged") Boolean paged, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("meetingDate") Object meetingDate, @Query("dateFormat") String dateFormat, @Query("locale") String locale)
      List Centers The default implementation supports pagination and sorting with the default pagination size set to 200 records. The parameter limit with description -1 will return all entries. Example Requests: centers centers?fields=name,officeName,joinedDate centers?offset=10&limit=50 centers?orderBy=name&sortOrder=DESC
      Parameters:
      officeId - officeId (optional)
      staffId - staffId (optional)
      externalId - externalId (optional)
      name - name (optional)
      underHierarchy - underHierarchy (optional)
      paged - paged (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      meetingDate - meetingDate (optional)
      dateFormat - dateFormat (optional)
      locale - locale (optional)
      Returns:
      Call<GetCentersResponse>

    • retrieveGroupAccount

      @GET("v1/centers/{centerId}/accounts") retrofit2.Call<GetCentersCenterIdAccountsResponse> retrieveGroupAccount(@Path("centerId") Long centerId)
      Retrieve Center accounts overview An example of how a savings summary for a Center can be provided. This is requested in a specific use case of the reference application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: centers/9/accounts
      Parameters:
      centerId - centerId (required)
      Returns:
      Call<GetCentersCenterIdAccountsResponse>

    • retrieveOne14

      @GET("v1/centers/{centerId}") retrofit2.Call<GetCentersCenterIdResponse> retrieveOne14(@Path("centerId") Long centerId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly)
      Retrieve a Center Retrieves a Center Example Requests: centers/1 centers/1?associations=groupMembers
      Parameters:
      centerId - centerId (required)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      Returns:
      Call<GetCentersCenterIdResponse>

    • retrieveTemplate6

      @GET("v1/centers/template") retrofit2.Call<GetCentersTemplateResponse> retrieveTemplate6(@Query("command") String command, @Query("officeId") Long officeId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly)
      Retrieve a Center Template Retrieves a Center Template Example Requests: centers/template centers/template?officeId=2
      Parameters:
      command - command (optional)
      officeId - officeId (optional)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      Returns:
      Call<GetCentersTemplateResponse>

    • update12

      @Headers("Content-Type:application/json") @PUT("v1/centers/{centerId}") retrofit2.Call<PutCentersCenterIdResponse> update12(@Path("centerId") Long centerId, @Body PutCentersCenterIdRequest putCentersCenterIdRequest)
      Update a Center Updates a Center
      Parameters:
      centerId - centerId (required)
      putCentersCenterIdRequest - (required)
      Returns:
      Call<PutCentersCenterIdResponse>

    • activate2

      @Headers("Content-Type:application/json") @POST("v1/centers/{centerId}") retrofit2.Call<PostCentersCenterIdResponse> activate2(@Path("centerId") Long centerId, @Body PostCentersCenterIdRequest postCentersCenterIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Activate a Center | Generate Collection Sheet | Save Collection Sheet | Close a Center | Associate Groups | Disassociate Groups Activate a Center: Centers can be created in a Pending state. This API exists to enable center activation. If the center happens to be already active, this API will result in an error. Close a Center: Centers can be closed if they don't have any non-closed groups or saving accounts. If the Center has any active groups or savings accounts, this API will result in an error. Associate Groups: This API allows associating existing groups to a center. The groups are listed from the office to which the center is associated. If group(s) is already associated with a center, this API will result in an error. Disassociate Groups: This API allows to disassociate groups from a center. Generate Collection Sheet: This Api retrieves repayment details of all jlg loans under a center as on a specified meeting date. Save Collection Sheet: This Api allows the loan officer to perform bulk repayments of JLG loans for a center on a given meeting date. Showing Request/Response for Close a Center
      Parameters:
      centerId - centerId (required)
      postCentersCenterIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostCentersCenterIdResponse>

    • create7

      @Headers("Content-Type:application/json") @POST("v1/centers") retrofit2.Call<PostCentersResponse> create7(@Body PostCentersRequest postCentersRequest, @HeaderMap Map<String,String> headers)
      Create a Center Creates a Center Mandatory Fields: name, officeId, active, activationDate (if active=true) Optional Fields: externalId, staffId, groupMembers
      Parameters:
      postCentersRequest - (required)
      Returns:
      Call<PostCentersResponse>

    • delete10

      @DELETE("v1/centers/{centerId}") retrofit2.Call<DeleteCentersCenterIdResponse> delete10(@Path("centerId") Long centerId, @HeaderMap Map<String,String> headers)
      Delete a Center A Center can be deleted if it is in pending state and has no association - groups, loans or savings
      Parameters:
      centerId - centerId (required)
      Returns:
      Call<DeleteCentersCenterIdResponse>

    • getCentersTemplate

      @GET("v1/centers/downloadtemplate") retrofit2.Call<Void> getCentersTemplate(@Query("officeId") Long officeId, @Query("staffId") Long staffId, @Query("dateFormat") String dateFormat, @HeaderMap Map<String,String> headers)
      Parameters:
      officeId - (optional)
      staffId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • postCentersTemplate

      @Multipart @POST("v1/centers/uploadtemplate") retrofit2.Call<String> postCentersTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream, @HeaderMap Map<String,String> headers)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • retrieveAll23

      @GET("v1/centers") retrofit2.Call<GetCentersResponse> retrieveAll23(@Query("officeId") Long officeId, @Query("staffId") Long staffId, @Query("externalId") String externalId, @Query("name") String name, @Query("underHierarchy") String underHierarchy, @Query("paged") Boolean paged, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("meetingDate") Object meetingDate, @Query("dateFormat") String dateFormat, @Query("locale") String locale, @HeaderMap Map<String,String> headers)
      List Centers The default implementation supports pagination and sorting with the default pagination size set to 200 records. The parameter limit with description -1 will return all entries. Example Requests: centers centers?fields=name,officeName,joinedDate centers?offset=10&limit=50 centers?orderBy=name&sortOrder=DESC
      Parameters:
      officeId - officeId (optional)
      staffId - staffId (optional)
      externalId - externalId (optional)
      name - name (optional)
      underHierarchy - underHierarchy (optional)
      paged - paged (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      meetingDate - meetingDate (optional)
      dateFormat - dateFormat (optional)
      locale - locale (optional)
      Returns:
      Call<GetCentersResponse>

    • retrieveGroupAccount

      @GET("v1/centers/{centerId}/accounts") retrofit2.Call<GetCentersCenterIdAccountsResponse> retrieveGroupAccount(@Path("centerId") Long centerId, @HeaderMap Map<String,String> headers)
      Retrieve Center accounts overview An example of how a savings summary for a Center can be provided. This is requested in a specific use case of the reference application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: centers/9/accounts
      Parameters:
      centerId - centerId (required)
      Returns:
      Call<GetCentersCenterIdAccountsResponse>

    • retrieveOne14

      @GET("v1/centers/{centerId}") retrofit2.Call<GetCentersCenterIdResponse> retrieveOne14(@Path("centerId") Long centerId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @HeaderMap Map<String,String> headers)
      Retrieve a Center Retrieves a Center Example Requests: centers/1 centers/1?associations=groupMembers
      Parameters:
      centerId - centerId (required)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      Returns:
      Call<GetCentersCenterIdResponse>

    • retrieveTemplate6

      @GET("v1/centers/template") retrofit2.Call<GetCentersTemplateResponse> retrieveTemplate6(@Query("command") String command, @Query("officeId") Long officeId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @HeaderMap Map<String,String> headers)
      Retrieve a Center Template Retrieves a Center Template Example Requests: centers/template centers/template?officeId=2
      Parameters:
      command - command (optional)
      officeId - officeId (optional)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      Returns:
      Call<GetCentersTemplateResponse>

    • update12

      @Headers("Content-Type:application/json") @PUT("v1/centers/{centerId}") retrofit2.Call<PutCentersCenterIdResponse> update12(@Path("centerId") Long centerId, @Body PutCentersCenterIdRequest putCentersCenterIdRequest, @HeaderMap Map<String,String> headers)
      Update a Center Updates a Center
      Parameters:
      centerId - centerId (required)
      putCentersCenterIdRequest - (required)
      Returns:
      Call<PutCentersCenterIdResponse>