api docs update

This commit is contained in:
John Woodlock
2012-05-31 17:23:39 +10:00
parent 445da9a4e0
commit 01f4b83a9c
2 changed files with 12 additions and 3 deletions
+10 -3
View File
@@ -1702,12 +1702,19 @@ Request Body:
<div class="method-section">
<div class="method-description">
<h4>Adjust a Repayment or Waiver</h4>
<p><b>Note:</b> there is no need to specify command={transactionType} parameter.</p>
</div>
<div class="method-example">
<code class="method-declaration">POST https://thedomainname/api/v1/loans/{loanId}/transactions/{transactionId}</code>
<code class="method-request">POST https://localhost:8443/mifosng-provider/api/v1/loans/10/transactions/20
Content-Type: application/json
Request Body:
<code class="method-request">POST https://localhost:8443/mifosng-provider/api/v1/loans/16/transactions/32
Content-Type: application/json
Request Body:{
"locale": "en_GB",
"dateFormat": "dd MMMM yyyy",
"transactionDate": "25 May 2012",
"transactionAmount": "50,000.00",
"note": "adj note"
}
</code>
<code class="method-response">{
"entityId": 10
+2
View File
@@ -56,6 +56,8 @@ retrieve: display transaction type value?
"principal" : null, "interest" : null, total, "totalWaived" : null, "overpaid" : null, and the offset - are nulls ever put in?
adjust:
when adjusting a disbursal - The server encountered an internal error () that prevented it from fulfilling this request.</u></p><p><b>exception</b> <pre>java.lang.IllegalArgumentException: Only repayment and waiver transactions can be adjusted.
on create and adjust returns clientId can it be transaction id or loanId?
list of loan transactions not available (except in summary presume repayments has repayments and waivers and adjusts)