CBSNexora/cbsnexora-backend
4
0
Fork 0
Code Issues Pull Requests Actions 47 Packages Projects Releases Wiki Activity

api docs update

Browse Source
This commit is contained in:
John Woodlock
2012-05-28 16:31:05 +10:00
parent d487c7a0fe
commit f2ee4f6219
1 changed files with 77 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
APIFolder/api.htm
+77 -51
View File
@@ -2058,57 +2058,83 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts</code> <code class="method-declaration">GET https://thedomainname/api/v1/loanproducts</code>
<code class="method-response"> { <code class="method-response">[ {
"products": [ "id" : 1,
{ "name" : "Agricultural Loan",
"id": 1, "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)",
"name": "Agricultural Loan", "principalMoney" : {
"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)", "currencyCode" : "XOF",
"principalMoney": { "currencyDigitsAfterDecimal" : 0,
"currencyCode": "XOF", "amount" : 100000,
"currencyDigitsAfterDecimal": 0, "defaultName" : "CFA Franc BCEAO",
"amount": 100000, "nameCode" : "currency.XOF",
"defaultName": "CFA Franc BCEAO", "displaySymbol" : "CFA",
"nameCode": "currency.XOF", "zero" : false,
"displaySymbol": "CFA", "greaterThanZero" : true,
"zero": false, "displaySymbolValue" : "100000 CFA"
"greaterThanZero": true, },
"displaySymbolValue": "100000 CFA" "interestRatePerPeriod" : 1.750000,
}, "interestRatePeriod" : 2,
"interestRatePerPeriod": 1.75, "annualInterestRate" : 21.000000,
"interestRatePeriod": 2, "interestMethod" : 0,
"annualInterestRate": 21, "interestRateCalculatedInPeriod" : 1,
"interestMethod": 0, "numberOfInterestFreePeriods" : 0,
"interestRateCalculatedInPeriod": 0, "repaidEvery" : 12,
"numberOfInterestFreePeriods": 0, "repaymentPeriodFrequency" : 2,
"repaidEvery": 12, "numberOfRepayments" : 1,
"repaymentPeriodFrequency": 2, "amortizationMethod" : 1,
"numberOfRepayments": 1, "inArrearsTolerance" : {
"amortizationMethod": 1, "currencyCode" : "XOF",
"inArrearsTolerance": { "currencyDigitsAfterDecimal" : 0,
"currencyCode": "XOF", "amount" : 1000,
"currencyDigitsAfterDecimal": 0, "defaultName" : "CFA Franc BCEAO",
"amount": 1000, "nameCode" : "currency.XOF",
"defaultName": "CFA Franc BCEAO", "displaySymbol" : "CFA",
"nameCode": "currency.XOF", "zero" : false,
"displaySymbol": "CFA", "greaterThanZero" : true,
"zero": false, "displaySymbolValue" : "1000 CFA"
"greaterThanZero": true, },
"displaySymbolValue": "1000 CFA" "createdOn" : 1334232874000,
}, "lastModifedOn" : 1334232874000
"createdOn": "2012-04-12T00:00:00.000+10:00", }, {
"lastModifedOn": "2012-04-12T00:00:00.000+10:00", "id" : 2,
"possibleCurrencies": [], "name" : "curr loan",
"possibleAmortizationOptions": [], "description" : "asdff",
"possibleInterestOptions": [], "principalMoney" : {
"possibleInterestRateCalculatedInPeriodOptions": [], "currencyCode" : "ETB",
"repaymentFrequencyOptions": [], "currencyDigitsAfterDecimal" : 2,
"interestFrequencyOptions": [], "amount" : 100000.00,
"interestRebateAllowed": false, "defaultName" : "Ethiopian Birr",
"flexible": false "nameCode" : "currency.ETB",
} "displaySymbol" : null,
] "zero" : false,
} "greaterThanZero" : true,
"displaySymbolValue" : "100000.00 null"
},
"interestRatePerPeriod" : 0.000000,
"interestRatePeriod" : 2,
"annualInterestRate" : 0.000000,
"interestMethod" : 0,
"interestRateCalculatedInPeriod" : 1,
"numberOfInterestFreePeriods" : 0,
"repaidEvery" : 1,
"repaymentPeriodFrequency" : 2,
"numberOfRepayments" : 5,
"amortizationMethod" : 1,
"inArrearsTolerance" : {
"currencyCode" : "ETB",
"currencyDigitsAfterDecimal" : 2,
"amount" : 0.00,
"defaultName" : "Ethiopian Birr",
"nameCode" : "currency.ETB",
"displaySymbol" : null,
"zero" : true,
"greaterThanZero" : false,
"displaySymbolValue" : "0.00 null"
},
"createdOn" : 1334475938000,
"lastModifedOn" : 1334475938000
} ]
</code> </code>
</div> </div>
</div> </div>