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

more api docs update

Browse Source
This commit is contained in:
John Woodlock
2012-05-28 17:20:15 +10:00
parent f2ee4f6219
commit d348fd18df
1 changed files with 167 additions and 237 deletions
Download Patch File Download Diff File Expand all files Collapse all files
APIFolder/api.htm
+88 -158
View File
@@ -473,7 +473,12 @@
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Retrieve Client Details Template</h4> <h4>Retrieve Client Details Template</h4>
<p>Returns a template that contains the client fields and allowed value lists. This helps build a maintenance User Interface.</p> <p>This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:
<ul>
<li class=normalli>Field Defaults</li>
<li class=normalli>Allowed Value Lists</li>
</ul>
</p>
<p>Example Request: <p>Example Request:
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/clients/template">https://localhost:8443/mifosng-provider/api/v1/clients/template</a> <a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/clients/template">https://localhost:8443/mifosng-provider/api/v1/clients/template</a>
</p> </p>
@@ -798,7 +803,11 @@ Request Body:
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Retrieve Loan Details Template</h4> <h4>Retrieve Loan Details Template</h4>
<p>Returns a template that contains client and loan product fields and allowed value lists. This helps build a maintenance User Interface. <p>This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:
<ul>
<li class=normalli>Field Defaults</li>
<li class=normalli>Allowed Value Lists</li>
</ul>
</p> </p>
<h5>Arguments</h5> <h5>Arguments</h5>
<dl class="argument-list"> <dl class="argument-list">
@@ -1786,7 +1795,11 @@ Request Body:
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Retrieve Loan Repayment/Loan Waiver Template</h4> <h4>Retrieve Loan Repayment/Loan Waiver Template</h4>
<p>Returns a template to help with entering loan repayments and waivers. <p>This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:
<ul>
<li class=normalli>Field Defaults</li>
<li class=normalli>Allowed Value Lists</li>
</ul>
</p> </p>
<h5>Arguments</h5> <h5>Arguments</h5>
<dl class="argument-list"> <dl class="argument-list">
@@ -2042,7 +2055,7 @@ Request Body:
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h3>Loan Products</h3> <h3>Loan Products</h3>
<p>A Loan product is a template that is used when creating a loan. Much of the template definition can be changed during loan creation. <p>A Loan product is a template that is used when creating a loan. Much of the template definition can be overridden during loan creation.
</p> </p>
</div> </div>
</div> </div>
@@ -2143,28 +2156,28 @@ Request Body:
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Retrieve Loan Product Details Template</h4> <h4>Retrieve Loan Product Details Template</h4>
<p>Returns a template that contains the loan product fields and allowed value lists. This helps build a maintenance User Interface. <p>This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:
</p> <ul>
<p>Example Request: <li class=normalli>Field Defaults</li>
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/loanproducts/template">https://localhost:8443/mifosng-provider/api/v1/loanproducts/template</a> <li class=normalli>Allowed Value Lists</li>
</ul>
</p> </p>
<p>Example Request: </p>
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/loanproducts/template?pretty=true">https://localhost:8443/mifosng-provider/api/v1/loanproducts/template?pretty=true</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/template</code> <code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/template</code>
<code class="method-response">{ <code class="method-response">{
"id": null,
"name": null,
"description": null,
"principalMoney" : { "principalMoney" : {
"currencyCode": "XOF", "currencyCode" : "ETB",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 2,
"amount": 0, "amount" : 0.00,
"defaultName": "CFA Franc BCEAO", "defaultName" : "Ethiopian Birr",
"nameCode": "currency.XOF", "nameCode" : "currency.ETB",
"displaySymbol": "CFA", "displaySymbol" : null,
"zero" : true, "zero" : true,
"greaterThanZero" : false, "greaterThanZero" : false,
"displaySymbolValue": "0 CFA" "displaySymbolValue" : "0.00 null"
}, },
"interestRatePerPeriod" : 0, "interestRatePerPeriod" : 0,
"interestRatePeriod" : 2, "interestRatePeriod" : 2,
@@ -2177,92 +2190,83 @@ Request Body:
"numberOfRepayments" : 0, "numberOfRepayments" : 0,
"amortizationMethod" : 1, "amortizationMethod" : 1,
"inArrearsTolerance" : { "inArrearsTolerance" : {
"currencyCode": "XOF", "currencyCode" : "ETB",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 2,
"amount": 0, "amount" : 0.00,
"defaultName": "CFA Franc BCEAO", "defaultName" : "Ethiopian Birr",
"nameCode": "currency.XOF", "nameCode" : "currency.ETB",
"displaySymbol": "CFA", "displaySymbol" : null,
"zero" : true, "zero" : true,
"greaterThanZero" : false, "greaterThanZero" : false,
"displaySymbolValue": "0 CFA" "displaySymbolValue" : "0.00 null"
}, },
"createdOn": null, "possibleCurrencies" : [ {
"lastModifedOn": null,
"possibleCurrencies": [
{
"code": "XOF",
"name": "CFA Franc BCEAO",
"decimalPlaces": 0,
"displaySymbol": "CFA",
"nameCode": "currency.XOF",
"displayLabel": "CFA Franc BCEAO (CFA)"
},
{
"code" : "ETB", "code" : "ETB",
"name" : "Ethiopian Birr", "name" : "Ethiopian Birr",
"decimalPlaces" : 2, "decimalPlaces" : 2,
"displaySymbol" : null, "displaySymbol" : null,
"nameCode" : "currency.ETB", "nameCode" : "currency.ETB",
"displayLabel" : "Ethiopian Birr [ETB]" "displayLabel" : "Ethiopian Birr [ETB]"
} }, {
], "code" : "XOF",
"possibleAmortizationOptions": [ "name" : "CFA Franc BCEAO",
{ "decimalPlaces" : 0,
"displaySymbol" : "CFA",
"nameCode" : "currency.XOF",
"displayLabel" : "CFA Franc BCEAO (CFA)"
}, {
"code" : "GBP",
"name" : "Pound Sterling",
"decimalPlaces" : 2,
"displaySymbol" : null,
"nameCode" : "currency.GBP",
"displayLabel" : "Pound Sterling [GBP]"
}, {
"code" : "USD",
"name" : "US Dollar",
"decimalPlaces" : 2,
"displaySymbol" : null,
"nameCode" : "currency.USD",
"displayLabel" : "US Dollar [USD]"
} ],
"possibleAmortizationOptions" : [ {
"id" : 1, "id" : 1,
"value" : "Equal installments" "value" : "Equal installments"
}, }, {
{
"id" : 0, "id" : 0,
"value" : "Equal principle payments" "value" : "Equal principle payments"
} } ],
], "possibleInterestOptions" : [ {
"possibleInterestOptions": [
{
"id" : 0, "id" : 0,
"value" : "Declining Balance" "value" : "Declining Balance"
}, }, {
{
"id" : 1, "id" : 1,
"value" : "Flat" "value" : "Flat"
} } ],
], "possibleInterestRateCalculatedInPeriodOptions" : [ {
"possibleInterestRateCalculatedInPeriodOptions": [
{
"id" : 0, "id" : 0,
"value" : "Daily" "value" : "Daily"
}, }, {
{
"id" : 1, "id" : 1,
"value" : "Same as repayment period" "value" : "Same as repayment period"
} } ],
], "repaymentFrequencyOptions" : [ {
"repaymentFrequencyOptions": [
{
"id" : 0, "id" : 0,
"value" : "Days" "value" : "Days"
}, }, {
{
"id" : 1, "id" : 1,
"value" : "Weeks" "value" : "Weeks"
}, }, {
{
"id" : 2, "id" : 2,
"value" : "Months" "value" : "Months"
} } ],
], "interestFrequencyOptions" : [ {
"interestFrequencyOptions": [
{
"id" : 2, "id" : 2,
"value" : "Per month" "value" : "Per month"
}, }, {
{
"id" : 3, "id" : 3,
"value" : "Per year" "value" : "Per year"
} } ]
],
"interestRebateAllowed": false,
"flexible": false
} }
</code> </code>
</div> </div>
@@ -2272,12 +2276,12 @@ Request Body:
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Retrieve a Loan Product</h4> <h4>Retrieve a Loan Product</h4>
<p>Returns loan product fields. It also returns allowed value lists which help build a maintenance User Interface. <p>Example Requests: </p>
JPW - includes validation values (might be ok or option), enum? <a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/loanproducts/1?pretty=true">https://localhost:8443/mifosng-provider/api/v1/loanproducts/1?pretty=true</a>
</p> <br><br>
<p>Example Request: <a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/loanproducts/1?pretty=true&template=true">https://localhost:8443/mifosng-provider/api/v1/loanproducts/1?pretty=true&template=true</a>
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/loanproducts/1">https://localhost:8443/mifosng-provider/api/v1/loanproducts/1</a> <br><br>
</p> <a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/loanproducts/1?pretty=true&fields=name,description,numberOfRepayments">https://localhost:8443/mifosng-provider/api/v1/loanproducts/1?pretty=true&fields=name,description,numberOfRepayments</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/{productId}</code> <code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/{productId}</code>
@@ -2296,11 +2300,11 @@ Request Body:
"greaterThanZero" : true, "greaterThanZero" : true,
"displaySymbolValue" : "100000 CFA" "displaySymbolValue" : "100000 CFA"
}, },
"interestRatePerPeriod": 1.75, "interestRatePerPeriod" : 1.750000,
"interestRatePeriod" : 2, "interestRatePeriod" : 2,
"annualInterestRate": 21, "annualInterestRate" : 21.000000,
"interestMethod" : 0, "interestMethod" : 0,
"interestRateCalculatedInPeriod": 0, "interestRateCalculatedInPeriod" : 1,
"numberOfInterestFreePeriods" : 0, "numberOfInterestFreePeriods" : 0,
"repaidEvery" : 12, "repaidEvery" : 12,
"repaymentPeriodFrequency" : 2, "repaymentPeriodFrequency" : 2,
@@ -2317,82 +2321,8 @@ Request Body:
"greaterThanZero" : true, "greaterThanZero" : true,
"displaySymbolValue" : "1000 CFA" "displaySymbolValue" : "1000 CFA"
}, },
"createdOn": "2012-04-12T00:00:00.000+10:00", "createdOn" : 1334232874000,
"lastModifedOn": "2012-04-12T00:00:00.000+10:00", "lastModifedOn" : 1334232874000
"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
} }
</code> </code>
</div> </div>