From de5b1209ae96aff55aef60e37b375256baf7161f Mon Sep 17 00:00:00 2001 From: Keith Woodlock Date: Mon, 21 May 2012 21:55:44 +0100 Subject: [PATCH] update loan product api request response examples. --- APIFolder/api.htm | 337 +++--------------- .../data/command/LoanProductCommand.java | 18 - 2 files changed, 50 insertions(+), 305 deletions(-) diff --git a/APIFolder/api.htm b/APIFolder/api.htm index 2c0275f93..8a57a7ac7 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -411,10 +411,8 @@ - - - - + +  
@@ -424,22 +422,7 @@ All subsequent offices added must have a parent office.

- - +  
@@ -652,159 +635,8 @@ Request Body:
-   -
-
-

Retrieve a Loan Product

-

Returns loan product fields. It also returns allowed value lists which help build a maintenance User Interface. - JPW - includes validation values (might be ok or option), enum? -

-

Example Request: - http://localhost:8080/mifosng-provider/api/v1/loanproducts/1 -

-
-
- GET https://thedomainname/api/v1/loanproducts/{productId} - { - "id": 1, - "name": "Agricultural Loan", - "description": "An agricultural loan given to farmers to help buy crop, stock and machinery. With an arrears tolerance setting of 1,000 CFA, loans are not marked as 'in arrears' or 'in bad standing' if the amount outstanding is less than this. Interest rate is described using monthly percentage rate (MPR) even though the loan typically lasts a year and requires one repayment (typically at time when farmer sells crop)", - "principalMoney": { - "currencyCode": "XOF", - "currencyDigitsAfterDecimal": 0, - "amount": 100000, - "defaultName": "CFA Franc BCEAO", - "nameCode": "currency.XOF", - "displaySymbol": "CFA", - "zero": false, - "greaterThanZero": true, - "displaySymbolValue": "100000 CFA" - }, - "interestRatePerPeriod": 1.75, - "interestRatePeriod": 2, - "annualInterestRate": 21, - "interestMethod": 0, - "interestRateCalculatedInPeriod": 0, - "numberOfInterestFreePeriods": 0, - "repaidEvery": 12, - "repaymentPeriodFrequency": 2, - "numberOfRepayments": 1, - "amortizationMethod": 1, - "inArrearsTolerance": { - "currencyCode": "XOF", - "currencyDigitsAfterDecimal": 0, - "amount": 1000, - "defaultName": "CFA Franc BCEAO", - "nameCode": "currency.XOF", - "displaySymbol": "CFA", - "zero": false, - "greaterThanZero": true, - "displaySymbolValue": "1000 CFA" - }, - "createdOn": "2012-04-12T00:00:00.000+10:00", - "lastModifedOn": "2012-04-12T00:00:00.000+10:00", - "possibleCurrencies": [ - { - "code": "XOF", - "name": "CFA Franc BCEAO", - "decimalPlaces": 0, - "displaySymbol": "CFA", - "nameCode": "currency.XOF", - "displayLabel": "CFA Franc BCEAO (CFA)" - }, - { - "code": "ETB", - "name": "Ethiopian Birr", - "decimalPlaces": 2, - "displaySymbol": null, - "nameCode": "currency.ETB", - "displayLabel": "Ethiopian Birr [ETB]" - } - ], - "possibleAmortizationOptions": [ - { - "id": 1, - "value": "Equal installments" - }, - { - "id": 0, - "value": "Equal principle payments" - } - ], - "possibleInterestOptions": [ - { - "id": 0, - "value": "Declining Balance" - }, - { - "id": 1, - "value": "Flat" - } - ], - "possibleInterestRateCalculatedInPeriodOptions": [ - { - "id": 0, - "value": "Daily" - }, - { - "id": 1, - "value": "Same as repayment period" - } - ], - "repaymentFrequencyOptions": [ - { - "id": 0, - "value": "Days" - }, - { - "id": 1, - "value": "Weeks" - }, - { - "id": 2, - "value": "Months" - } - ], - "interestFrequencyOptions": [ - { - "id": 2, - "value": "Per month" - }, - { - "id": 3, - "value": "Per year" - } - ], - "interestRebateAllowed": false, - "flexible": false - } - -
-
- - -   -
-
-

Create a Loan Product

-
-
- POST https://thedomainname/api/v1/loanproducts - http://localhost:8080/mifosng-provider/api/v1/loanproducts - - - Content-Type: application/json - Request Body: - new loan product json here - -
-
- - -   -
- - + +  
@@ -813,57 +645,13 @@ Request Body:

- -
-
-
Attributes
-
-
- id -
-
- string jpw ipsum as an example of showing the (at least important) columns -
-
- amount -
-
positive integer or zero -
-
Amount charged in cents
-
- card -
-
-
hash
-
- Hash describing the card used to make the charge -
- -
- inner object -
-
inner string inner span extra -
-
-
-
- fingerprint -
-
string or something -
-
-
-
- - -  

List Loan Products

Example Request: - http://localhost:8080/mifosng-provider/api/v1/loanproducts + https://localhost:8443/mifosng-provider/api/v1/loanproducts

@@ -916,53 +704,6 @@ Request Body: "interestFrequencyOptions": [], "interestRebateAllowed": false, "flexible": false - }, - { - "id": 2, - "name": "curr loan", - "description": "asdff", - "principalMoney": { - "currencyCode": "ETB", - "currencyDigitsAfterDecimal": 2, - "amount": 100000, - "defaultName": "Ethiopian Birr", - "nameCode": "currency.ETB", - "displaySymbol": null, - "zero": false, - "greaterThanZero": true, - "displaySymbolValue": "100000.00 null" - }, - "interestRatePerPeriod": 0, - "interestRatePeriod": 2, - "annualInterestRate": 0, - "interestMethod": 0, - "interestRateCalculatedInPeriod": 0, - "numberOfInterestFreePeriods": 0, - "repaidEvery": 1, - "repaymentPeriodFrequency": 2, - "numberOfRepayments": 5, - "amortizationMethod": 1, - "inArrearsTolerance": { - "currencyCode": "ETB", - "currencyDigitsAfterDecimal": 2, - "amount": 0, - "defaultName": "Ethiopian Birr", - "nameCode": "currency.ETB", - "displaySymbol": null, - "zero": true, - "greaterThanZero": false, - "displaySymbolValue": "0.00 null" - }, - "createdOn": "2012-04-15T00:00:00.000+10:00", - "lastModifedOn": "2012-04-15T00:00:00.000+10:00", - "possibleCurrencies": [], - "possibleAmortizationOptions": [], - "possibleInterestOptions": [], - "possibleInterestRateCalculatedInPeriodOptions": [], - "repaymentFrequencyOptions": [], - "interestFrequencyOptions": [], - "interestRebateAllowed": false, - "flexible": false } ] } @@ -970,7 +711,6 @@ Request Body:
-  
@@ -978,7 +718,7 @@ Request Body:

Returns a template that contains the loan product fields and allowed value lists. This helps build a maintenance User Interface.

Example Request: - http://localhost:8080/mifosng-provider/api/v1/loanproducts/template + https://localhost:8443/mifosng-provider/api/v1/loanproducts/template

@@ -1100,7 +840,6 @@ Request Body:
-  
@@ -1109,7 +848,7 @@ Request Body: JPW - includes validation values (might be ok or option), enum?

Example Request: - http://localhost:8080/mifosng-provider/api/v1/loanproducts/1 + https://localhost:8443/mifosng-provider/api/v1/loanproducts/1

@@ -1230,8 +969,7 @@ Request Body:
- - +  
@@ -1239,17 +977,29 @@ Request Body:
POST https://thedomainname/api/v1/loanproducts - http://localhost:8080/mifosng-provider/api/v1/loanproducts - - - Content-Type: application/json - Request Body: - new loan product json here - +https://localhost:8443/mifosng-provider/api/v1/loanproducts +Content-Type: application/json +Request Body: +{ + "name": "New kind of Loan", + "description": "A description not exceeding 500 characters.", + "currencyCode": "XOF", + "digitsAfterDecimal": 0, + "principal": 100000, + "inArrearsToleranceAmount": 1000, + "numberOfRepayments": 1, + "repaymentEvery": 1, + "repaymentFrequency": 2, + "amortizationMethod": 1, + "interestRatePerPeriod": 1.75, + "interestRateFrequencyMethod": 2, + "interestCalculationPeriodMethod": 1, + "interestMethod": 0 +} +
-  
@@ -1257,16 +1007,29 @@ Request Body:
POST https://thedomainname/api/v1/loanproducts/{loanId} - http://localhost:8080/mifosng-provider/api/v1/loanproducts/1 - - - Content-Type: application/json - Request Body: - update loan product json here - +https://localhost:8443/mifosng-provider/api/v1/loanproducts/1 +Content-Type: application/json +Request Body: +{ + "name": "New kind of Loan updated", + "description": "An updated description not exceeding 500 characters.", + "currencyCode": "XOF", + "digitsAfterDecimal": 0, + "principal": 100000, + "inArrearsToleranceAmount": 1000, + "numberOfRepayments": 1, + "repaymentEvery": 1, + "repaymentFrequency": 2, + "amortizationMethod": 1, + "interestRatePerPeriod": 1.75, + "interestRateFrequencyMethod": 2, + "interestCalculationPeriodMethod": 1, + "interestMethod": 0 +} +
- +   diff --git a/mifosng-data/src/main/java/org/mifosng/data/command/LoanProductCommand.java b/mifosng-data/src/main/java/org/mifosng/data/command/LoanProductCommand.java index 1ad474822..4cc6299bf 100644 --- a/mifosng-data/src/main/java/org/mifosng/data/command/LoanProductCommand.java +++ b/mifosng-data/src/main/java/org/mifosng/data/command/LoanProductCommand.java @@ -26,8 +26,6 @@ public class LoanProductCommand { private Integer amortizationMethod; private Integer interestMethod; private Integer interestCalculationPeriodMethod; - private boolean flexibleRepaymentSchedule = false; - private boolean interestRebateAllowed = false; protected LoanProductCommand() { // @@ -161,20 +159,4 @@ public class LoanProductCommand { Integer interestCalculationPeriodMethod) { this.interestCalculationPeriodMethod = interestCalculationPeriodMethod; } - - public boolean isFlexibleRepaymentSchedule() { - return flexibleRepaymentSchedule; - } - - public void setFlexibleRepaymentSchedule(boolean flexibleRepaymentSchedule) { - this.flexibleRepaymentSchedule = flexibleRepaymentSchedule; - } - - public boolean isInterestRebateAllowed() { - return interestRebateAllowed; - } - - public void setInterestRebateAllowed(boolean interestRebateAllowed) { - this.interestRebateAllowed = interestRebateAllowed; - } } \ No newline at end of file