Package org.apache.fineract.client.services

Interface RolesApi

public interface RolesApi

  • Method Details

    • actionsOnRoles

      @POST("v1/roles/{roleId}") retrofit2.Call<PostRolesRoleIdResponse> actionsOnRoles(@Path("roleId") Long roleId, @Query("command") String command)
      Enable Role | Disable Role Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users. Example Request: https://DomainName/api/v1/roles/{roleId}?command=enable https://DomainName/api/v1/roles/{roleId}?command=disable
      Parameters:
      roleId - roleId (required)
      command - command (optional)
      Returns:
      Call<PostRolesRoleIdResponse>

    • createRole

      @Headers("Content-Type:application/json") @POST("v1/roles") retrofit2.Call<PostRolesResponse> createRole(@Body PostRolesRequest postRolesRequest)
      Create a New Role Mandatory Fields name, description
      Parameters:
      postRolesRequest - (required)
      Returns:
      Call<PostRolesResponse>

    • deleteRole

      @DELETE("v1/roles/{roleId}") retrofit2.Call<DeleteRolesRoleIdResponse> deleteRole(@Path("roleId") Long roleId)
      Delete a Role Description : Delete the role in case role is not associated with any users.
      Parameters:
      roleId - roleId (required)
      Returns:
      Call<DeleteRolesRoleIdResponse>

    • retrieveAllRoles

      @GET("v1/roles") retrofit2.Call<List<GetRolesResponse>> retrieveAllRoles()
      List Roles Example Requests: roles roles?fields=name
      Returns:
      Call<List<GetRolesResponse>>

    • retrieveRole

      @GET("v1/roles/{roleId}") retrofit2.Call<GetRolesRoleIdResponse> retrieveRole(@Path("roleId") Long roleId)
      Retrieve a Role Example Requests: roles/1 roles/1?fields=name
      Parameters:
      roleId - roleId (required)
      Returns:
      Call<GetRolesRoleIdResponse>

    • retrieveRolePermissions

      @GET("v1/roles/{roleId}/permissions") retrofit2.Call<GetRolesRoleIdPermissionsResponse> retrieveRolePermissions(@Path("roleId") Long roleId)
      Retrieve a Role's Permissions Example Requests: roles/1/permissions
      Parameters:
      roleId - roleId (required)
      Returns:
      Call<GetRolesRoleIdPermissionsResponse>

    • updateRole

      @Headers("Content-Type:application/json") @PUT("v1/roles/{roleId}") retrofit2.Call<PutRolesRoleIdResponse> updateRole(@Path("roleId") Long roleId, @Body PutRolesRoleIdRequest putRolesRoleIdRequest)
      Update a Role
      Parameters:
      roleId - roleId (required)
      putRolesRoleIdRequest - (required)
      Returns:
      Call<PutRolesRoleIdResponse>

    • updateRolePermissions

      @Headers("Content-Type:application/json") @PUT("v1/roles/{roleId}/permissions") retrofit2.Call<PutRolesRoleIdPermissionsResponse> updateRolePermissions(@Path("roleId") Long roleId, @Body PutRolesRoleIdPermissionsRequest putRolesRoleIdPermissionsRequest)
      Update a Role's Permissions
      Parameters:
      roleId - roleId (required)
      putRolesRoleIdPermissionsRequest - (required)
      Returns:
      Call<PutRolesRoleIdPermissionsResponse>

    • actionsOnRoles

      @POST("v1/roles/{roleId}") retrofit2.Call<PostRolesRoleIdResponse> actionsOnRoles(@Path("roleId") Long roleId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Enable Role | Disable Role Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users. Example Request: https://DomainName/api/v1/roles/{roleId}?command=enable https://DomainName/api/v1/roles/{roleId}?command=disable
      Parameters:
      roleId - roleId (required)
      command - command (optional)
      Returns:
      Call<PostRolesRoleIdResponse>

    • createRole

      @Headers("Content-Type:application/json") @POST("v1/roles") retrofit2.Call<PostRolesResponse> createRole(@Body PostRolesRequest postRolesRequest, @HeaderMap Map<String,String> headers)
      Create a New Role Mandatory Fields name, description
      Parameters:
      postRolesRequest - (required)
      Returns:
      Call<PostRolesResponse>

    • deleteRole

      @DELETE("v1/roles/{roleId}") retrofit2.Call<DeleteRolesRoleIdResponse> deleteRole(@Path("roleId") Long roleId, @HeaderMap Map<String,String> headers)
      Delete a Role Description : Delete the role in case role is not associated with any users.
      Parameters:
      roleId - roleId (required)
      Returns:
      Call<DeleteRolesRoleIdResponse>

    • retrieveAllRoles

      @GET("v1/roles") retrofit2.Call<List<GetRolesResponse>> retrieveAllRoles(@HeaderMap Map<String,String> headers)
      List Roles Example Requests: roles roles?fields=name
      Returns:
      Call<List<GetRolesResponse>>

    • retrieveRole

      @GET("v1/roles/{roleId}") retrofit2.Call<GetRolesRoleIdResponse> retrieveRole(@Path("roleId") Long roleId, @HeaderMap Map<String,String> headers)
      Retrieve a Role Example Requests: roles/1 roles/1?fields=name
      Parameters:
      roleId - roleId (required)
      Returns:
      Call<GetRolesRoleIdResponse>

    • retrieveRolePermissions

      @GET("v1/roles/{roleId}/permissions") retrofit2.Call<GetRolesRoleIdPermissionsResponse> retrieveRolePermissions(@Path("roleId") Long roleId, @HeaderMap Map<String,String> headers)
      Retrieve a Role's Permissions Example Requests: roles/1/permissions
      Parameters:
      roleId - roleId (required)
      Returns:
      Call<GetRolesRoleIdPermissionsResponse>

    • updateRole

      @Headers("Content-Type:application/json") @PUT("v1/roles/{roleId}") retrofit2.Call<PutRolesRoleIdResponse> updateRole(@Path("roleId") Long roleId, @Body PutRolesRoleIdRequest putRolesRoleIdRequest, @HeaderMap Map<String,String> headers)
      Update a Role
      Parameters:
      roleId - roleId (required)
      putRolesRoleIdRequest - (required)
      Returns:
      Call<PutRolesRoleIdResponse>

    • updateRolePermissions

      @Headers("Content-Type:application/json") @PUT("v1/roles/{roleId}/permissions") retrofit2.Call<PutRolesRoleIdPermissionsResponse> updateRolePermissions(@Path("roleId") Long roleId, @Body PutRolesRoleIdPermissionsRequest putRolesRoleIdPermissionsRequest, @HeaderMap Map<String,String> headers)
      Update a Role's Permissions
      Parameters:
      roleId - roleId (required)
      putRolesRoleIdPermissionsRequest - (required)
      Returns:
      Call<PutRolesRoleIdPermissionsResponse>