diff --git a/APIFolder/apiLive.htm b/APIFolder/apiLive.htm index 1a73b7a34..c3c739cc3 100644 --- a/APIFolder/apiLive.htm +++ b/APIFolder/apiLive.htm @@ -163,7 +163,7 @@ The REST plugins will allow you to

Example Request:

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/template?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/template?pretty=true
GET https://thedomainname/api/v1/clients/template @@ -570,11 +570,11 @@ var jqxhr = $.ajax({

Retrieve a Client

Example Requests:

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true&template=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true&template=true

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true&fields=id,displayName,officeName + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true&fields=id,displayName,officeName
GET https://thedomainname/api/v1/clients/{clientId} @@ -608,7 +608,7 @@ var jqxhr = $.ajax({
POST https://thedomainname/api/v1/clients -POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients Content-Type: application/json Request Body: { @@ -635,7 +635,7 @@ Request Body:
PUT https://thedomainname/api/v1/clients/{clientId} -PUT https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/23 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/23 Content-Type: application/json Request Body: { @@ -658,9 +658,9 @@ Request Body: However, it is quite reasonable to add resources like this to simplify User Interface development.

Example Requests:

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?pretty=true

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?pretty=true&fields=openLoans,%20closedLoans,activeLoanCount + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?pretty=true&fields=openLoans,%20closedLoans,activeLoanCount
GET https://thedomainname/api/v1/clients/{clientId}/notes @@ -756,7 +756,7 @@ Request Body:
POST https://thedomainname/api/v1/clients/{clientId}/notes - POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/notes + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/notes Content-Type: application/json Request Body: { @@ -775,9 +775,9 @@ Request Body:
GET https://thedomainname/api/v1/clients/{clientId}/notes/{noteId} @@ -806,7 +806,7 @@ Request Body:
PUT https://thedomainname/api/v1/clients/{clientId}/notes/{noteId} -PUT https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20 Content-Type: application/json Request Body: { @@ -896,9 +896,9 @@ Request Body:
If entered, productId, productName and selectedProduct fields are returned.

Example Requests:

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/template?clientId=1&productId=1&pretty=true + 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

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/template?clientId=1&pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/template?clientId=1&pretty=true
GET https://thedomainname/api/v1/loans/{loanId} @@ -1503,7 +1503,7 @@ Request Body:
POST https://thedomainname/api/v1/loans - POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans Content-Type: application/json Request Body: { @@ -1557,7 +1557,7 @@ Request Body:
POST https://thedomainname/api/v1/loans/{loanId} - POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?command=approve + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?command=approve Content-Type: application/json Request Body: { @@ -1581,7 +1581,7 @@ Request Body:
DELETE https://thedomainname/api/v1/loans/{loanId} - DELETE https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1 + DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1 Content-Type: application/json No Request Body: @@ -1614,7 +1614,7 @@ No Request Body: "total" "amount" is set to the remaining loan principal outstanding.

Example Request:

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/10/transactions/template?command=repayment&pretty=true + 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
GET https://thedomainname/api/v1/loans/{loanId}/transactions/template" @@ -1648,7 +1648,7 @@ No Request Body:
POST https://thedomainname/api/v1/loans/{loanId}/transactions - POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/37/transactions?command=repayment + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/37/transactions?command=repayment Content-Type: application/json Request Body: { @@ -1671,7 +1671,7 @@ Request Body:
GET https://thedomainname/api/v1/loans/{loanId}/transactions/{transactionId} @@ -1710,7 +1710,7 @@ Request Body:
POST https://thedomainname/api/v1/loans/{loanId}/transactions/{transactionId} - POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/16/transactions/32 + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/16/transactions/32 Content-Type: application/json Request Body: { @@ -1760,9 +1760,9 @@ Request Body:
@@ -1834,16 +1834,16 @@ Request Body:
@@ -1872,7 +1872,7 @@ Request Body:
POST https://thedomainname/api/v1/offices -POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices Content-Type: application/json Request Body: { @@ -1897,7 +1897,7 @@ Request Body:
PUT https://thedomainname/api/v1/offices/{officeId} -PUT https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1 Content-Type: application/json Request Body: { @@ -1974,9 +1974,9 @@ Request Body:
GET https://thedomainname/api/v1/loanproducts/template @@ -2266,11 +2266,11 @@ Request Body:
GET https://thedomainname/api/v1/loanproducts/{productId} @@ -2349,7 +2349,7 @@ Request Body:
POST https://thedomainname/api/v1/loanproducts -POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts Content-Type: application/json Request Body: { @@ -2384,7 +2384,7 @@ Request Body:
POST https://thedomainname/api/v1/loanproducts/{loanId} -POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1 +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1 Content-Type: application/json Request Body: { @@ -2416,9 +2416,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-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?pretty=true

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?pretty=true&fields=selectedCurrencyOptions + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?pretty=true&fields=selectedCurrencyOptions
GET https://thedomainname/api/v1/configurations/currency @@ -2467,7 +2467,7 @@ Request Body:
PUT https://thedomainname/api/v1/configurations/currency - PUT https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency + PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency Content-Type: application/json Request Body:{ "currencies": ["KES", "BND", "LBP", "GHC", "USD", "XOF", "AED", "AMD"] @@ -2528,9 +2528,9 @@ Request Body:{
The Additional Fields Type (Mifos X database table) to restrict the output to

Example Requests:

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?type=portfolio_client&pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?type=portfolio_client&pretty=true

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?pretty=true
GET https://thedomainname/api/v1/additionalfields @@ -2560,7 +2560,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-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2?pretty=true

@@ -2638,7 +2638,7 @@ Request Body:{
POST https://thedomainname/api/v1/additionalfields/{type}/{set}/{id} - POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2 + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2 Content-Type: application/json Request Body: { @@ -2697,9 +2697,9 @@ Request Body:
Output will be delivered as a CSV file instead of JSON.

Example Requests:

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?pretty=true

- https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?pretty=true&exportCSV=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?pretty=true&exportCSV=true
GET https://thedomainname/api/v1/reports/{reportName} @@ -2927,7 +2927,7 @@ Request Body:
POST https://thedomainname/api/v1/authentication?username={username}&password={password} -POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/authentication?username=super1&password=demo +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/authentication?username=super1&password=demo Content-Type: application/json No Request Body @@ -2961,9 +2961,9 @@ No Request Body
GET https://thedomainname/api/v1/users/template @@ -3061,11 +3061,11 @@ No Request Body
GET https://thedomainname/api/v1/users/1 @@ -3125,7 +3125,7 @@ No Request Body
POST https://thedomainname/api/v1/users -POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users Content-Type: application/json Request body: { @@ -3153,7 +3153,7 @@ Request body:
PUT https://thedomainname/api/v1/users/{userId) -PUT https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/3 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/3 Content-Type: application/json Request body: { @@ -3180,7 +3180,7 @@ Request body:
DELETE https://thedomainname/api/v1/users/{userId} -DELETE https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/20 +DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/20 Content-Type: application/json No Request Body @@ -3207,9 +3207,9 @@ No Request Body
GET https://thedomainname/api/v1/roles/template @@ -3285,11 +3285,11 @@ No Request Body
GET https://thedomainname/api/v1/roles/{roleId} @@ -3334,7 +3334,7 @@ No Request Body
POST https://thedomainname/api/v1/roles -POST https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles Content-Type: application/json Request body: { @@ -3357,7 +3357,7 @@ Request body:
PUT https://thedomainname/api/v1/roles/{roleId} -PUT https://ec2-176-34-174-133.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/8 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/8 Content-Type: application/json Request body: { @@ -3387,9 +3387,9 @@ Request body:
GET https://thedomainname/api/v1/permissions