diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 0ce29c2ee..c6f387069 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -133,14 +133,19 @@ function getBaseURL(docURL)
-

Additional Fields

+

Non-Core Data

- - -
RESOURCES
POST
create/complex update
GET
read
PUT
update
DELETE
delete
ADDITIONAL FIELDSadditionalfieldsList Additional Fields Sets
additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields
+ ADDITIONAL FIELDSadditionalfields (deprecated)List Additional Fields Sets + additionalfields/{Type}/{Set}/{id} (deprecated)Update Additional FieldsRetrieve Additional Fields + DATA TABLEdatatablesList Data Tables + datatables/register/{datatable}/{apptable}Register Data Table + datatables/deregister/{datatable}Deregister Data Table + datatables/{datatable}/{apptableId}Create Entry in Data TableRetrieve Entry(s) from Data TableUpdate Entry in Data Table (One to One)Delete Entry(s) in Data Table + datatables/{datatable}/{apptableId}/{datatableId}Update Entry in Data Table (One to Many)Delete Entry in Data Table (One to Many) +
@@ -2214,7 +2219,7 @@ Request Body:{  
-

Additional Fields

+

Additional Fields (Deprecated)

In Mifos X, any number of "Sets" of "Additional Fields" can be configured for a Mifos X database table ("Type").

@@ -3171,16 +3176,21 @@ Request body: LOAN PRODUCTloanproductsCreate a Loan ProductList Loan Products loanproducts/{productId}Retrieve a Loan ProductUpdate a Loan Product CONFIGURATIONconfigurations/currencyRetrieve Currency ConfigurationUpdate Currency Configuration - ADDITIONAL FIELDSadditionalfieldsList Additional Fields Sets - additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields - REPORTreportsList Reports - reports/{reportName}Run a Report - AUTHENTICATIONauthenticationVerify Authentication - USERusersCreate a UserList Users - users/{userId}Retrieve a UserUpdate a UserDelete a User - ROLErolesCreate a New RoleList Roles - roles/{roleId}Retrieve a RoleUpdate a Role - PERMISSIONpermissionsList Application Permissions + ADDITIONAL FIELDSadditionalfields (deprecated)List Additional Fields Sets + additionalfields/{Type}/{Set}/{id} (deprecated)Update Additional FieldsRetrieve Additional Fields + DATA TABLEdatatablesList Data Tables + datatables/register/{datatable}/{apptable}Register Data Table + datatables/deregister/{datatable}Deregister Data Table + datatables/{datatable}/{apptableId}Create Entry in Data TableRetrieve Entry(s) from Data TableUpdate Entry in Data Table (One to One)Delete Entry(s) in Data Table + datatables/{datatable}/{apptableId}/{datatableId}Update Entry in Data Table (One to Many)Delete Entry in Data Table (One to Many) + REPORTreportsList Reports + reports/{reportName}Run a Report + AUTHENTICATIONauthenticationVerify Authentication + USERusersCreate a UserList Users + users/{userId}Retrieve a UserUpdate a UserDelete a User + ROLErolesCreate a New RoleList Roles + roles/{roleId}Retrieve a RoleUpdate a Role + PERMISSIONpermissionsList Application Permissions
diff --git a/mifosng-provider/src/main/java/org/mifosng/platform/api/DataTableApiResource.java b/mifosng-provider/src/main/java/org/mifosng/platform/api/DataTableApiResource.java index 008cc5f36..500c45f3d 100644 --- a/mifosng-provider/src/main/java/org/mifosng/platform/api/DataTableApiResource.java +++ b/mifosng-provider/src/main/java/org/mifosng/platform/api/DataTableApiResource.java @@ -62,11 +62,11 @@ public class DataTableApiResource { @GET @Consumes({ MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_JSON }) - public String getDatatables(@QueryParam("appTable") final String appTable, + public String getDatatables(@QueryParam("apptable") final String apptable, @Context final UriInfo uriInfo) { List result = this.readWriteNonCoreDataService - .retrieveDatatableNames(appTable); + .retrieveDatatableNames(apptable); boolean prettyPrint = ApiParameterHelper.prettyPrint(uriInfo .getQueryParameters()); @@ -75,21 +75,21 @@ public class DataTableApiResource { } @POST - @Path("/register/{datatable}/{appTable}") + @Path("register/{datatable}/{apptable}") @Consumes({ MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_JSON }) public Response registerDatatable( @PathParam("datatable") final String datatable, - @PathParam("appTable") final String appTable) { + @PathParam("apptable") final String apptable) { - this.readWriteNonCoreDataService.registerDatatable(datatable, appTable); + this.readWriteNonCoreDataService.registerDatatable(datatable, apptable); EntityIdentifier entityIdentifier = new EntityIdentifier(); return Response.ok().entity(entityIdentifier).build(); } @POST - @Path("/deregister/{datatable}") + @Path("deregister/{datatable}") @Consumes({ MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_JSON }) public Response deregisterDatatable( @@ -102,11 +102,11 @@ public class DataTableApiResource { } @GET - @Path("{datatable}/{appTableId}") + @Path("{datatable}/{apptableId}") @Consumes({ MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_JSON }) public String getDatatable(@PathParam("datatable") final String datatable, - @PathParam("appTableId") final Long appTableId, + @PathParam("apptableId") final Long apptableId, @QueryParam("sqlFields") final String sqlFields, @QueryParam("sqlOrder") final String sqlOrder, @Context final UriInfo uriInfo) { @@ -121,7 +121,7 @@ public class DataTableApiResource { */ GenericResultsetData results = this.readWriteNonCoreDataService - .retrieveDataTableGenericResultSet(datatable, appTableId, + .retrieveDataTableGenericResultSet(datatable, apptableId, sqlFields, sqlOrder, null); boolean prettyPrints = ApiParameterHelper.prettyPrint(uriInfo @@ -132,34 +132,34 @@ public class DataTableApiResource { } @POST - @Path("{datatable}/{appTableId}") + @Path("{datatable}/{apptableId}") @Consumes({ MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_JSON }) public Response newDatatableEntry( @PathParam("datatable") final String datatable, - @PathParam("appTableId") final Long appTableId, + @PathParam("apptableId") final Long apptableId, final String jsonRequestBody) { checkUserPermissionForDatatable(datatable, "CREATE"); Map queryParams = getQueryParamsFromJsonRequestBody(jsonRequestBody); this.readWriteNonCoreDataService.newDatatableEntry(datatable, - appTableId, queryParams); + apptableId, queryParams); EntityIdentifier entityIdentifier = new EntityIdentifier( - Long.valueOf(appTableId)); + Long.valueOf(apptableId)); return Response.ok().entity(entityIdentifier).build(); } @PUT - @Path("{datatable}/{appTableId}") + @Path("{datatable}/{apptableId}") @Consumes({ MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_JSON }) public Response updateDatatableEntryOnetoOne( @PathParam("datatable") final String datatable, - @PathParam("appTableId") final Long appTableId, + @PathParam("apptableId") final Long apptableId, final String jsonRequestBody) { /* * for updating one to one relationships (where foreign key is the @@ -169,22 +169,22 @@ public class DataTableApiResource { Map queryParams = getQueryParamsFromJsonRequestBody(jsonRequestBody); this.readWriteNonCoreDataService.updateDatatableEntryOnetoOne( - datatable, appTableId, queryParams); + datatable, apptableId, queryParams); EntityIdentifier entityIdentifier = new EntityIdentifier( - Long.valueOf(appTableId)); + Long.valueOf(apptableId)); return Response.ok().entity(entityIdentifier).build(); } @PUT - @Path("{datatable}/{appTableId}/{datatableId}") + @Path("{datatable}/{apptableId}/{datatableId}") @Consumes({ MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_JSON }) public Response updateDatatableEntryOnetoOne( @PathParam("datatable") final String datatable, - @PathParam("appTableId") final Long appTableId, + @PathParam("apptableId") final Long apptableId, @PathParam("datatableId") final Long datatableId, final String jsonRequestBody) { /* @@ -195,51 +195,51 @@ public class DataTableApiResource { Map queryParams = getQueryParamsFromJsonRequestBody(jsonRequestBody); this.readWriteNonCoreDataService.updateDatatableEntryOnetoMany( - datatable, appTableId, datatableId, queryParams); + datatable, apptableId, datatableId, queryParams); EntityIdentifier entityIdentifier = new EntityIdentifier( - Long.valueOf(appTableId)); + Long.valueOf(apptableId)); return Response.ok().entity(entityIdentifier).build(); } @DELETE - @Path("{datatable}/{appTableId}") + @Path("{datatable}/{apptableId}") @Consumes({ MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_JSON }) public Response deleteDatatableEntries( @PathParam("datatable") final String datatable, - @PathParam("appTableId") final Long appTableId) { + @PathParam("apptableId") final Long apptableId) { checkUserPermissionForDatatable(datatable, "DELETE"); this.readWriteNonCoreDataService.deleteDatatableEntries(datatable, - appTableId); + apptableId); EntityIdentifier entityIdentifier = new EntityIdentifier( - Long.valueOf(appTableId)); + Long.valueOf(apptableId)); return Response.ok().entity(entityIdentifier).build(); } @DELETE - @Path("{datatable}/{appTableId}/{datatableId}") + @Path("{datatable}/{apptableId}/{datatableId}") @Consumes({ MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_JSON }) public Response deleteDatatableEntries( @PathParam("datatable") final String datatable, - @PathParam("appTableId") final Long appTableId, + @PathParam("apptableId") final Long apptableId, @PathParam("datatableId") final Long datatableId) { checkUserPermissionForDatatable(datatable, "DELETE"); this.readWriteNonCoreDataService.deleteDatatableEntry(datatable, - appTableId, datatableId); + apptableId, datatableId); EntityIdentifier entityIdentifier = new EntityIdentifier( - Long.valueOf(appTableId)); + Long.valueOf(apptableId)); return Response.ok().entity(entityIdentifier).build();