MIFOSX-336: update api docs request and response examples for loanType parameter.
This commit is contained in:
+15
-10
@@ -3786,9 +3786,9 @@ GET https://DomainName/mifosng-provider/api/v1/groups
|
|||||||
At present there are three type of loans are supported.
|
At present there are three type of loans are supported.
|
||||||
<br>Available loan types:
|
<br>Available loan types:
|
||||||
<ol>
|
<ol>
|
||||||
<li>id=1, code=individual, description: Loan given to individual member</li>
|
<li><b>individual</b>: Loan given to individual member</li>
|
||||||
<li>id=2, code=group, description: Loan given to group as a whole</li>
|
<li><b>group</b>: Loan given to group as a whole</li>
|
||||||
<li>id=3, code=jlg, description: Joint liability group loan given to members in a group on individual basis. JLG loan can be given to one or more members in a group.</li>
|
<li><b>jlg</b>: Joint liability group loan given to members in a group on individual basis. JLG loan can be given to one or more members in a group.</li>
|
||||||
</ol>
|
</ol>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@@ -3843,14 +3843,14 @@ GET https://DomainName/mifosng-provider/api/v1/groups
|
|||||||
fields are returned.</dd>
|
fields are returned.</dd>
|
||||||
</dl>
|
</dl>
|
||||||
<p>Example Requests:</p>
|
<p>Example Requests:</p>
|
||||||
<div class=apiClick>loans/template?clientId=1</div>
|
<div class=apiClick>loans/template?templateType=individual&clientId=1</div>
|
||||||
<br>
|
<br>
|
||||||
<br>
|
<br>
|
||||||
<div class=apiClick>loans/template?clientId=1&productId=1</div>
|
<div class=apiClick>loans/template?templateType=individual&clientId=1&productId=1</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="method-example">
|
<div class="method-example">
|
||||||
<code class="method-declaration">
|
<code class="method-declaration">
|
||||||
GET https://DomainName/api/v1/loans/template?clientId=1
|
GET https://DomainName/api/v1/loans/template?templateType=individual&clientId=1
|
||||||
</code>
|
</code>
|
||||||
<code class="method-response">
|
<code class="method-response">
|
||||||
{
|
{
|
||||||
@@ -3873,7 +3873,7 @@ GET https://DomainName/api/v1/loans/template?clientId=1
|
|||||||
}
|
}
|
||||||
</code>
|
</code>
|
||||||
<code class="method-declaration">
|
<code class="method-declaration">
|
||||||
GET https://DomainName/api/v1/loans/template?clientId=1&productId=1
|
GET https://DomainName/api/v1/loans/template?templateType=individual&clientId=1&productId=1
|
||||||
</code>
|
</code>
|
||||||
<code class="method-response">
|
<code class="method-response">
|
||||||
{
|
{
|
||||||
@@ -4123,8 +4123,7 @@ GET https://DomainName/api/v1/loans/template?clientId=1&productId=1
|
|||||||
<div class="method-description">
|
<div class="method-description">
|
||||||
<h4>Retrieve a Loan</h4>
|
<h4>Retrieve a Loan</h4>
|
||||||
<p>
|
<p>
|
||||||
<b>Note:</b> template=true parameter doesn't apply to this
|
<b>Note:</b> template=true parameter doesn't apply to this resource.
|
||||||
resource.
|
|
||||||
</p>
|
</p>
|
||||||
<h5>Arguments</h5>
|
<h5>Arguments</h5>
|
||||||
<dl class="argument-list">
|
<dl class="argument-list">
|
||||||
@@ -4200,6 +4199,11 @@ GET https://DomainName/api/v1/loans/{loanId}
|
|||||||
"loanPurposeName": "option.HousingImprovement",
|
"loanPurposeName": "option.HousingImprovement",
|
||||||
"loanOfficerId": 2,
|
"loanOfficerId": 2,
|
||||||
"loanOfficerName": "LoanOfficer, Kampala",
|
"loanOfficerName": "LoanOfficer, Kampala",
|
||||||
|
"loanType": {
|
||||||
|
"id": 1,
|
||||||
|
"code": "loanType.individual",
|
||||||
|
"value": "Individual"
|
||||||
|
},
|
||||||
"currency": {
|
"currency": {
|
||||||
"code": "UGX",
|
"code": "UGX",
|
||||||
"name": "Uganda Shilling",
|
"name": "Uganda Shilling",
|
||||||
@@ -4493,7 +4497,7 @@ Request Body:
|
|||||||
</tr>
|
</tr>
|
||||||
<tr class=alt>
|
<tr class=alt>
|
||||||
<td>clientId, productId, principal, loanTermFrequency,
|
<td>clientId, productId, principal, loanTermFrequency,
|
||||||
loanTermFrequencyType, numberOfRepayments, repaymentEvery,
|
loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery,
|
||||||
repaymentFrequencyType, interestRatePerPeriod,
|
repaymentFrequencyType, interestRatePerPeriod,
|
||||||
amortizationType, interestType,
|
amortizationType, interestType,
|
||||||
interestCalculationPeriodType, transactionProcessingStrategyId,
|
interestCalculationPeriodType, transactionProcessingStrategyId,
|
||||||
@@ -4517,6 +4521,7 @@ Request Body:
|
|||||||
"principal": "100,000.00",
|
"principal": "100,000.00",
|
||||||
"loanTermFrequency": 12,
|
"loanTermFrequency": 12,
|
||||||
"loanTermFrequencyType": 2,
|
"loanTermFrequencyType": 2,
|
||||||
|
"loanType": "individual"
|
||||||
"numberOfRepayments": 12,
|
"numberOfRepayments": 12,
|
||||||
"repaymentEvery": 1,
|
"repaymentEvery": 1,
|
||||||
"repaymentFrequencyType": 2,
|
"repaymentFrequencyType": 2,
|
||||||
|
|||||||
Reference in New Issue
Block a user