Package org.apache.fineract.client.services

Interface UsersApi

public interface UsersApi

  • Method Details

    • changePassword

      @Headers("Content-Type:application/json") @POST("v1/users/{userId}/pwd") retrofit2.Call<ChangePwdUsersUserIdResponse> changePassword(@Path("userId") Long userId, @Body ChangePwdUsersUserIdRequest changePwdUsersUserIdRequest)
      Change the password of a User When updating a password you must provide the repeatPassword parameter also.
      Parameters:
      userId - userId (required)
      changePwdUsersUserIdRequest - (required)
      Returns:
      Call<ChangePwdUsersUserIdResponse>

    • create15

      @Headers("Content-Type:application/json") @POST("v1/users") retrofit2.Call<PostUsersResponse> create15(@Body PostUsersRequest postUsersRequest)
      Create a User Adds new application user. Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete). Mandatory Fields: username, firstname, lastname, email, officeId, roles, sendPasswordToEmail Optional Fields: staffId,passwordNeverExpires,isSelfServiceUser,clients
      Parameters:
      postUsersRequest - (required)
      Returns:
      Call<PostUsersResponse>

    • delete23

      @DELETE("v1/users/{userId}") retrofit2.Call<DeleteUsersUserIdResponse> delete23(@Path("userId") Long userId)
      Delete a User Removes the user and the associated roles and permissions.
      Parameters:
      userId - userId (required)
      Returns:
      Call<DeleteUsersUserIdResponse>

    • getUserTemplate

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

    • postUsersTemplate

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

    • retrieveAll41

      @GET("v1/users") retrofit2.Call<List<GetUsersResponse>> retrieveAll41()
      Retrieve list of users Example Requests: users users?fields=id,username,email,officeName
      Returns:
      Call<List<GetUsersResponse>>

    • retrieveOne31

      @GET("v1/users/{userId}") retrofit2.Call<GetUsersUserIdResponse> retrieveOne31(@Path("userId") Long userId)
      Retrieve a User Example Requests: users/1 users/1?template=true users/1?fields=username,officeName
      Parameters:
      userId - userId (required)
      Returns:
      Call<GetUsersUserIdResponse>

    • template22

      @GET("v1/users/template") retrofit2.Call<GetUsersTemplateResponse> template22()
      Retrieve User Details 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: users/template
      Returns:
      Call<GetUsersTemplateResponse>

    • update26

      @Headers("Content-Type:application/json") @PUT("v1/users/{userId}") retrofit2.Call<PutUsersUserIdResponse> update26(@Path("userId") Long userId, @Body PutUsersUserIdRequest putUsersUserIdRequest)
      Update a User Updates the user
      Parameters:
      userId - userId (required)
      putUsersUserIdRequest - (required)
      Returns:
      Call<PutUsersUserIdResponse>

    • changePassword

      @Headers("Content-Type:application/json") @POST("v1/users/{userId}/pwd") retrofit2.Call<ChangePwdUsersUserIdResponse> changePassword(@Path("userId") Long userId, @Body ChangePwdUsersUserIdRequest changePwdUsersUserIdRequest, @HeaderMap Map<String,String> headers)
      Change the password of a User When updating a password you must provide the repeatPassword parameter also.
      Parameters:
      userId - userId (required)
      changePwdUsersUserIdRequest - (required)
      Returns:
      Call<ChangePwdUsersUserIdResponse>

    • create15

      @Headers("Content-Type:application/json") @POST("v1/users") retrofit2.Call<PostUsersResponse> create15(@Body PostUsersRequest postUsersRequest, @HeaderMap Map<String,String> headers)
      Create a User Adds new application user. Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete). Mandatory Fields: username, firstname, lastname, email, officeId, roles, sendPasswordToEmail Optional Fields: staffId,passwordNeverExpires,isSelfServiceUser,clients
      Parameters:
      postUsersRequest - (required)
      Returns:
      Call<PostUsersResponse>

    • delete23

      @DELETE("v1/users/{userId}") retrofit2.Call<DeleteUsersUserIdResponse> delete23(@Path("userId") Long userId, @HeaderMap Map<String,String> headers)
      Delete a User Removes the user and the associated roles and permissions.
      Parameters:
      userId - userId (required)
      Returns:
      Call<DeleteUsersUserIdResponse>

    • getUserTemplate

      @GET("v1/users/downloadtemplate") retrofit2.Call<Void> getUserTemplate(@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>

    • postUsersTemplate

      @Multipart @POST("v1/users/uploadtemplate") retrofit2.Call<String> postUsersTemplate(@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>

    • retrieveAll41

      @GET("v1/users") retrofit2.Call<List<GetUsersResponse>> retrieveAll41(@HeaderMap Map<String,String> headers)
      Retrieve list of users Example Requests: users users?fields=id,username,email,officeName
      Returns:
      Call<List<GetUsersResponse>>

    • retrieveOne31

      @GET("v1/users/{userId}") retrofit2.Call<GetUsersUserIdResponse> retrieveOne31(@Path("userId") Long userId, @HeaderMap Map<String,String> headers)
      Retrieve a User Example Requests: users/1 users/1?template=true users/1?fields=username,officeName
      Parameters:
      userId - userId (required)
      Returns:
      Call<GetUsersUserIdResponse>

    • template22

      @GET("v1/users/template") retrofit2.Call<GetUsersTemplateResponse> template22(@HeaderMap Map<String,String> headers)
      Retrieve User Details 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: users/template
      Returns:
      Call<GetUsersTemplateResponse>

    • update26

      @Headers("Content-Type:application/json") @PUT("v1/users/{userId}") retrofit2.Call<PutUsersUserIdResponse> update26(@Path("userId") Long userId, @Body PutUsersUserIdRequest putUsersUserIdRequest, @HeaderMap Map<String,String> headers)
      Update a User Updates the user
      Parameters:
      userId - userId (required)
      putUsersUserIdRequest - (required)
      Returns:
      Call<PutUsersUserIdResponse>