Parameter "fields={fieldlist}" can be used on GET requests to restrict the fields returned.
Example Request:
- - https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true&fields=id,name,parentName + offices/1?fields=id,name,parentNameExample Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients?tenantIdentifier=default&pretty=true + clientsGET https://Domain Name/api/v1/clients
@@ -463,7 +482,7 @@ var jqxhr = $.ajax({
Example Request:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/template?tenantIdentifier=default&pretty=true + clients/templateGET https://Domain Name/api/v1/clients/template
@@ -496,11 +515,11 @@ var jqxhr = $.ajax({
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?tenantIdentifier=default&pretty=true + clients/1GET https://Domain Name/api/v1/clients/{clientId}
@@ -534,7 +553,7 @@ var jqxhr = $.ajax({
POST https://Domain Name/api/v1/clients
-POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients
+POST clients
Content-Type: application/json
Request Body:
{
@@ -553,7 +572,7 @@ Request Body:
POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients
+POST clients
Content-Type: application/json
Request Body:
{
@@ -579,7 +598,7 @@ Request Body:
PUT https://Domain Name/api/v1/clients/{clientId}
-PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/23
+PUT clients/23
Content-Type: application/json
Request Body:
{
@@ -602,9 +621,9 @@ Request Body:
However, it is quite reasonable to add resources like this to simplify User Interface development.
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?tenantIdentifier=default&pretty=true
+ clients/1/loans
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?tenantIdentifier=default&pretty=true&fields=openLoans,%20closedLoans,activeLoanCount
+ clients/1/loans?fields=openLoans,%20closedLoans,activeLoanCount
GET https://Domain Name/api/v1/clients/{clientId}/loans
@@ -656,9 +675,9 @@ Request Body:
Note: Notes are returned in descending createOn order.
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes?tenantIdentifier=default&pretty=true + clients/2/notesGET https://Domain Name/api/v1/clients/{clientId}/notes
@@ -708,7 +727,7 @@ Request Body:
POST https://Domain Name/api/v1/clients/{clientId}/notes
- POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/notes
+ POST clients/1/notes
Content-Type: application/json
Request Body:
{
@@ -727,9 +746,9 @@ Request Body:
Retrieve a Client Note
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20?tenantIdentifier=default&pretty=true
+ clients/2/notes/20
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20?tenantIdentifier=default&pretty=true&fields=note,createdOn,createdByUsername
+ clients/2/notes/20?fields=note,createdOn,createdByUsername
GET https://Domain Name/api/v1/clients/{clientId}/notes/{noteId}
@@ -762,7 +781,7 @@ Request Body:
PUT https://Domain Name/api/v1/clients/{clientId}/notes/{noteId}
-PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20
+PUT clients/2/notes/20
Content-Type: application/json
Request Body:
{
@@ -851,9 +870,9 @@ Request Body:
- If entered, productId, productName and selectedProduct fields are returned.
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/template?clientId=1&productId=1&pretty=true
+ loans/template?clientId=1&productId=1
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/template?clientId=1&pretty=true
+ loans/template?clientId=1
GET https://Domain Name/api/v1/loans/template
@@ -1061,13 +1080,13 @@ Request Body:
- 'convenienceData': Some derived data that is specific to the needs of the current Individual Lending client application.
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true
+ loans/1
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true&fields=id,principal,annualInterestRate
+ loans/1?fields=id,principal,annualInterestRate
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true&associations=all
+ loans/1?associations=all
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true&fields=id,principal,annualInterestRate&associations=summary,repaymentSchedule
+ loans/1?fields=id,principal,annualInterestRate&associations=summary,repaymentSchedule
GET https://Domain Name/api/v1/loans/{loanId}
@@ -1164,7 +1183,7 @@ Request Body:
POST https://Domain Name/api/v1/loans
- POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans
+ POST loans
Content-Type: application/json
Request Body:
{
@@ -1216,7 +1235,7 @@ Request Body:
POST https://Domain Name/api/v1/loans/{loanId}
- POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?command=approve
+ POST loans/1?command=approve
Content-Type: application/json
Request Body:
{
@@ -1240,7 +1259,7 @@ Request Body:
DELETE https://Domain Name/api/v1/loans/{loanId}
- DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1
+ DELETE loans/1
Content-Type: application/json
No Request Body:
@@ -1274,7 +1293,7 @@ No Request Body:
The amount that can be waived is limited to the loan's inArrearsTolerance
Example Request:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/10/transactions/template?command=repayment&pretty=true
+ loans/10/transactions/template?command=repayment
GET https://Domain Name/api/v1/loans/{loanId}/transactions/template"
@@ -1313,7 +1332,7 @@ No Request Body:
POST https://Domain Name/api/v1/loans/{loanId}/transactions
- POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/37/transactions?command=repayment
+ POST loans/37/transactions?command=repayment
Content-Type: application/json
Request Body:
{
@@ -1336,7 +1355,7 @@ Request Body:
Retrieve a Repayment or Waiver Details
Example Request:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/10/transactions/20?tenantIdentifier=default&pretty=true
+ loans/10/transactions/20
GET https://Domain Name/api/v1/loans/{loanId}/transactions/{transactionId}
@@ -1375,7 +1394,7 @@ Request Body:
POST https://Domain Name/api/v1/loans/{loanId}/transactions/{transactionId}
- POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/16/transactions/32
+ POST loans/16/transactions/32
Content-Type: application/json
Request Body:
{
@@ -1424,9 +1443,9 @@ Request Body:
List Offices
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices?tenantIdentifier=default&pretty=true
+ offices
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices?fields=id,name,openingDate&pretty=true
+ offices?fields=id,name,openingDate
GET https://Domain Name/api/v1/offices
@@ -1470,8 +1489,8 @@ Request Body:
Example Request:
-
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/template?tenantIdentifier=default&pretty=true
+
+ offices/template
@@ -1498,16 +1517,16 @@ Request Body:
Retrieve an Office
Example Requests:
-
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true
+
+ offices/1
-
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true&template=true
+
+ offices/1?template=true
-
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true&fields=id,name,parentName
+
+ offices/1?fields=id,name,parentName
@@ -1536,7 +1555,7 @@ Request Body:
POST https://Domain Name/api/v1/offices
-POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices
+POST offices
Content-Type: application/json
Request Body:
{
@@ -1561,7 +1580,7 @@ Request Body:
PUT https://Domain Name/api/v1/offices/{officeId}
-PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1
+PUT offices/1
Content-Type: application/json
Request Body:
{
@@ -1638,9 +1657,9 @@ Request Body:
List Loan Products
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts?tenantIdentifier=default&pretty=true
+ loanproducts
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts?tenantIdentifier=default&pretty=true&fields=name,description,interestRateFrequencyType,amortizationType
+ loanproducts?fields=name,description,interestRateFrequencyType,amortizationType
GET https://Domain Name/api/v1/loanproducts
@@ -1774,7 +1793,7 @@ Request Body:
Example Request:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/template?tenantIdentifier=default&pretty=true
+ loanproducts/template
GET https://Domain Name/api/v1/loanproducts/template
@@ -1930,11 +1949,11 @@ Request Body:
Retrieve a Loan Product
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?tenantIdentifier=default&pretty=true
+ loanproducts/1
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?tenantIdentifier=default&pretty=true&template=true
+ loanproducts/1?template=true
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?tenantIdentifier=default&pretty=true&fields=name,description,numberOfRepayments
+ loanproducts/1?fields=name,description,numberOfRepayments
GET https://Domain Name/api/v1/loanproducts/{productId}
@@ -2013,7 +2032,7 @@ Request Body:
POST https://Domain Name/api/v1/loanproducts
-POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts
+POST loanproducts
Content-Type: application/json
Request Body:
{
@@ -2048,7 +2067,7 @@ Request Body:
POST https://Domain Name/api/v1/loanproducts/{loanId}
-POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1
+POST loanproducts/1
Content-Type: application/json
Request Body:
{
@@ -2080,9 +2099,9 @@ Request Body:
Retrieve Currency Configuration
Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection).
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?tenantIdentifier=default&pretty=true
+ configurations/currency
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?tenantIdentifier=default&pretty=true&fields=selectedCurrencyOptions
+ configurations/currency?fields=selectedCurrencyOptions
GET https://Domain Name/api/v1/configurations/currency
@@ -2131,7 +2150,7 @@ Request Body:
PUT https://Domain Name/api/v1/configurations/currency
- PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency
+ PUT configurations/currency
Content-Type: application/json
Request Body:{
"currencies": ["KES", "BND", "LBP", "GHC", "USD", "XOF", "AED", "AMD"]
@@ -2192,9 +2211,9 @@ Request Body:{
- The Additional Fields Type (Mifos X database table) to restrict the output to
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?type=portfolio_client&pretty=true
+ additionalfields?type=m_client
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?tenantIdentifier=default&pretty=true
+ additionalfields
GET https://Domain Name/api/v1/additionalfields
@@ -2224,7 +2243,7 @@ Request Body:{
Returns the Set of Additional Fields data for the ID provided. The ID is the id field of the Type table e.g. portfolio_client might have an id value of 4. The output is a JSON formatted "Generic Resultset". The Generic Resultset contains Column Heading as well as Data information. The Column Heading information may include allowed values (columnValues array).
Example Request:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2?tenantIdentifier=default&pretty=true
+ additionalfields/m_client/Additional Information/2
@@ -2302,7 +2321,7 @@ Request Body:{
POST https://Domain Name/api/v1/additionalfields/{type}/{set}/{id}
- POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2
+ POST additionalfields/portfolio_client/Additional Information/2
Content-Type: application/json
Request Body:
{
@@ -2361,9 +2380,9 @@ Request Body:
- Output will be delivered as a CSV file instead of JSON.
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?tenantIdentifier=default&pretty=true
+ reports
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?tenantIdentifier=default&pretty=true&exportCSV=true
+ reports?exportCSV=true
GET https://Domain Name/api/v1/reports
@@ -2483,13 +2502,13 @@ Request Body:
- Output will be delivered as a CSV file instead of JSON. Doesn't apply to Pentaho reports .
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1&pretty=true
+ reports/Client%20Listing?R_officeId=1
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1&pretty=true&exportCSV=true
+ reports/Client%20Listing?R_officeId=1&exportCSV=true
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports/selectOfficeId?R_officeId=1&pretty=true& parameterType=true
+ reports/selectOfficeId?R_officeId=1& parameterType=true
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports/selectOfficeId?R_officeId=1&pretty=true& parameterType=true&exportCSV=true
+ reports/selectOfficeId?R_officeId=1& parameterType=true&exportCSV=true
GET https://Domain Name/api/v1/reports/{reportName}
@@ -2591,7 +2610,7 @@ Request Body:
POST https://Domain Name/api/v1/authentication?username={username}&password={password}
-POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/authentication?username=super1&password=demo
+POST authentication?username=super1&password=demo
Content-Type: application/json
No Request Body
@@ -2625,9 +2644,9 @@ No Request Body
Retrieve list of users
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users?tenantIdentifier=default&pretty=true
+ users
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users?tenantIdentifier=default&pretty=true&fields=id,username,email,officeName
+ users?fields=id,username,email,officeName
GET https://Domain Name/api/v1/users
@@ -2663,7 +2682,7 @@ No Request Body
Example Request:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/template?tenantIdentifier=default&pretty=true
+ users/template
GET https://Domain Name/api/v1/users/template
@@ -2725,11 +2744,11 @@ No Request Body
Retrieve a User
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?tenantIdentifier=default&pretty=true
+ users/1
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?tenantIdentifier=default&pretty=true&template=true
+ users/1?template=true
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?tenantIdentifier=default&pretty=true&fields=username,officeName
+ users/1?fields=username,officeName
GET https://Domain Name/api/v1/users/1
@@ -2789,7 +2808,7 @@ No Request Body
POST https://Domain Name/api/v1/users
-POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users
+POST users
Content-Type: application/json
Request body:
{
@@ -2817,7 +2836,7 @@ Request body:
PUT https://Domain Name/api/v1/users/{userId)
-PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/3
+PUT users/3
Content-Type: application/json
Request body:
{
@@ -2844,7 +2863,7 @@ Request body:
DELETE https://Domain Name/api/v1/users/{userId}
-DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/20
+DELETE users/20
Content-Type: application/json
No Request Body
@@ -2871,9 +2890,9 @@ No Request Body
List Roles
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles?tenantIdentifier=default&pretty=true
+ roles
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles?tenantIdentifier=default&pretty=true&fields=name
+ roles?fields=name
GET https://Domain Name/api/v1/roles
@@ -2913,7 +2932,7 @@ No Request Body
Example Request:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/template?tenantIdentifier=default&pretty=true
+ roles/template
GET https://Domain Name/api/v1/roles/template
@@ -2949,11 +2968,11 @@ No Request Body
Retrieve a Role
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?tenantIdentifier=default&pretty=true
+ roles/1
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?tenantIdentifier=default&pretty=true&template=true
+ roles/1?template=true
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?tenantIdentifier=default&pretty=true&fields=name,selectedPermissions
+ roles/1?fields=name,selectedPermissions
GET https://Domain Name/api/v1/roles/{roleId}
@@ -2998,7 +3017,7 @@ No Request Body
POST https://Domain Name/api/v1/roles
-POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles
+POST roles
Content-Type: application/json
Request body:
{
@@ -3021,7 +3040,7 @@ Request body:
PUT https://Domain Name/api/v1/roles/{roleId}
-PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/8
+PUT roles/8
Content-Type: application/json
Request body:
{
@@ -3051,9 +3070,9 @@ Request body:
List Application Permissions
Example Requests:
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/permissions?tenantIdentifier=default&pretty=true
+ permissions
- https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/permissions?tenantIdentifier=default&pretty=true&fields=id,code
+ permissions?fields=id,code
GET https://Domain Name/api/v1/permissions