Package org.apache.fineract.useradministration.api

Class UsersApiResource

java.lang.Object

org.apache.fineract.useradministration.api.UsersApiResource

@Path("/v1/users")
@Component
public class UsersApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
UsersApiResource()

Method Summary

Modifier and Type	Method	Description
String	changePassword(Long userId, String apiRequestBodyAsJson)
String	create(String apiRequestBodyAsJson)
String	delete(Long userId)
jakarta.ws.rs.core.Response	getUserTemplate(Long officeId, Long staffId, String dateFormat)
String	postUsersTemplate(InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String locale, String dateFormat)
String	retrieveAll(jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveOne(Long userId, jakarta.ws.rs.core.UriInfo uriInfo)
String	template(jakarta.ws.rs.core.UriInfo uriInfo)
String	update(Long userId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UsersApiResource

public UsersApiResource()

Method Details

retrieveAll

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveAll(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveOne

@GET
@Path("{userId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveOne(@PathParam("userId")
 Long userId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

template

@GET
@Path("template")
@Consumes("application/json")
@Produces("application/json")
public String template(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

create

@POST
@Consumes("application/json")
@Produces("application/json")
public String create(String apiRequestBodyAsJson)

update

@PUT
@Path("{userId}")
@Consumes("application/json")
@Produces("application/json")
public String update(@PathParam("userId")
 Long userId,
 String apiRequestBodyAsJson)

changePassword

@POST
@Path("{userId}/pwd")
@Consumes("application/json")
@Produces("application/json")
public String changePassword(@PathParam("userId")
 Long userId,
 String apiRequestBodyAsJson)

delete

@DELETE
@Path("{userId}")
@Consumes("application/json")
@Produces("application/json")
public String delete(@PathParam("userId")
 Long userId)

getUserTemplate

@GET
@Path("downloadtemplate")
@Produces("application/vnd.ms-excel")
public jakarta.ws.rs.core.Response getUserTemplate(@QueryParam("officeId")
 Long officeId,
 @QueryParam("staffId")
 Long staffId,
 @QueryParam("dateFormat")
 String dateFormat)

postUsersTemplate

@POST
@Path("uploadtemplate")
@Consumes("multipart/form-data")
public String postUsersTemplate(InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
 String locale,
 String dateFormat)