Package org.apache.fineract.client.services

Interface StaffApi

public interface StaffApi

  • Method Details

    • create3

      @Headers("Content-Type:application/json") @POST("v1/staff") retrofit2.Call<CreateStaffResponse> create3(@Body StaffRequest staffRequest)
      Create a staff member Creates a staff member. Mandatory Fields: officeId, firstname, lastname Optional Fields: isLoanOfficer, isActive
      Parameters:
      staffRequest - (required)
      Returns:
      Call<CreateStaffResponse>

    • getTemplate1

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

    • postTemplate

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

    • retrieveAll16

      @GET("v1/staff") retrofit2.Call<List<StaffData>> retrieveAll16(@Query("officeId") Long officeId, @Query("staffInOfficeHierarchy") Boolean staffInOfficeHierarchy, @Query("loanOfficersOnly") Boolean loanOfficersOnly, @Query("status") String status)
      Retrieve Staff Returns the list of staff members. Example Requests: staff Retrieve a Staff by status Returns the details of a Staff based on status. By default it Returns all the ACTIVE Staff. If status=INACTIVE, then it returns all INACTIVE Staff. and for status=ALL, it Returns both ACTIVE and INACTIVE Staff. Example Requests: staff?status=active
      Parameters:
      officeId - officeId (optional)
      staffInOfficeHierarchy - staffInOfficeHierarchy (optional, default to false)
      loanOfficersOnly - loanOfficersOnly (optional, default to false)
      status - status (optional, default to active)
      Returns:
      Call<List<StaffData>>

    • retrieveOne8

      @GET("v1/staff/{staffId}") retrofit2.Call<StaffData> retrieveOne8(@Path("staffId") Long staffId)
      Retrieve a Staff Member Returns the details of a Staff Member. Example Requests: staff/1
      Parameters:
      staffId - staffId (required)
      Returns:
      Call<StaffData>

    • update7

      @Headers("Content-Type:application/json") @PUT("v1/staff/{staffId}") retrofit2.Call<UpdateStaffResponse> update7(@Path("staffId") Long staffId, @Body PutStaffRequest putStaffRequest)
      Update a Staff Member Updates the details of a staff member.
      Parameters:
      staffId - staffId (required)
      putStaffRequest - (required)
      Returns:
      Call<UpdateStaffResponse>

    • create3

      @Headers("Content-Type:application/json") @POST("v1/staff") retrofit2.Call<CreateStaffResponse> create3(@Body StaffRequest staffRequest, @HeaderMap Map<String,String> headers)
      Create a staff member Creates a staff member. Mandatory Fields: officeId, firstname, lastname Optional Fields: isLoanOfficer, isActive
      Parameters:
      staffRequest - (required)
      Returns:
      Call<CreateStaffResponse>

    • getTemplate1

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

    • postTemplate

      @Multipart @POST("v1/staff/uploadtemplate") retrofit2.Call<Long> postTemplate(@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<Long>

    • retrieveAll16

      @GET("v1/staff") retrofit2.Call<List<StaffData>> retrieveAll16(@Query("officeId") Long officeId, @Query("staffInOfficeHierarchy") Boolean staffInOfficeHierarchy, @Query("loanOfficersOnly") Boolean loanOfficersOnly, @Query("status") String status, @HeaderMap Map<String,String> headers)
      Retrieve Staff Returns the list of staff members. Example Requests: staff Retrieve a Staff by status Returns the details of a Staff based on status. By default it Returns all the ACTIVE Staff. If status=INACTIVE, then it returns all INACTIVE Staff. and for status=ALL, it Returns both ACTIVE and INACTIVE Staff. Example Requests: staff?status=active
      Parameters:
      officeId - officeId (optional)
      staffInOfficeHierarchy - staffInOfficeHierarchy (optional, default to false)
      loanOfficersOnly - loanOfficersOnly (optional, default to false)
      status - status (optional, default to active)
      Returns:
      Call<List<StaffData>>

    • retrieveOne8

      @GET("v1/staff/{staffId}") retrofit2.Call<StaffData> retrieveOne8(@Path("staffId") Long staffId, @HeaderMap Map<String,String> headers)
      Retrieve a Staff Member Returns the details of a Staff Member. Example Requests: staff/1
      Parameters:
      staffId - staffId (required)
      Returns:
      Call<StaffData>

    • update7

      @Headers("Content-Type:application/json") @PUT("v1/staff/{staffId}") retrofit2.Call<UpdateStaffResponse> update7(@Path("staffId") Long staffId, @Body PutStaffRequest putStaffRequest, @HeaderMap Map<String,String> headers)
      Update a Staff Member Updates the details of a staff member.
      Parameters:
      staffId - staffId (required)
      putStaffRequest - (required)
      Returns:
      Call<UpdateStaffResponse>