Package org.apache.fineract.organisation.office.api

Class OfficesApiResource

java.lang.Object

org.apache.fineract.organisation.office.api.OfficesApiResource

@Path("/v1/offices")
@Component
public class OfficesApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
OfficesApiResource()

Method Summary

Modifier and Type	Method	Description
String	createOffice(String apiRequestBodyAsJson)
jakarta.ws.rs.core.Response	getOfficeTemplate(String dateFormat)
String	postOfficeTemplate(InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String locale, String dateFormat)
String	retrieveOffice(Long officeId, jakarta.ws.rs.core.UriInfo uriInfo)
org.apache.fineract.organisation.office.api.OfficesApiResourceSwagger.GetOfficesResponse	retrieveOfficeByExternalId(String externalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveOffices(jakarta.ws.rs.core.UriInfo uriInfo, boolean onlyManualEntries, String orderBy, String sortOrder)
String	retrieveOfficeTemplate(jakarta.ws.rs.core.UriInfo uriInfo)
String	updateOffice(Long officeId, String apiRequestBodyAsJson)
org.apache.fineract.organisation.office.api.OfficesApiResourceSwagger.PutOfficesOfficeIdResponse	updateOfficeWithExternalId(String externalId, org.apache.fineract.organisation.office.api.OfficesApiResourceSwagger.PutOfficesOfficeIdRequest apiRequestBody)

Methods inherited from class java.lang.Object

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

Constructor Details

OfficesApiResource

public OfficesApiResource()

Method Details

retrieveOffices

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveOffices(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @DefaultValue("false") @QueryParam("includeAllOffices")
 boolean onlyManualEntries,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder)

retrieveOfficeTemplate

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

createOffice

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

retrieveOffice

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

retrieveOfficeByExternalId

@GET
@Path("/external-id/{externalId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.organisation.office.api.OfficesApiResourceSwagger.GetOfficesResponse retrieveOfficeByExternalId(@PathParam("externalId")
 String externalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

updateOffice

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

updateOfficeWithExternalId

@PUT
@Path("/external-id/{externalId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.organisation.office.api.OfficesApiResourceSwagger.PutOfficesOfficeIdResponse updateOfficeWithExternalId(@PathParam("externalId")
 String externalId,
 org.apache.fineract.organisation.office.api.OfficesApiResourceSwagger.PutOfficesOfficeIdRequest apiRequestBody)

getOfficeTemplate

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

postOfficeTemplate

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