more api doc updates

This commit is contained in:
John Woodlock
2012-05-31 14:19:12 +10:00
parent b491d53f10
commit c37041e6b7
2 changed files with 41 additions and 26 deletions
+15 -9
View File
@@ -1538,7 +1538,12 @@ Request Body:
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Approve, Undo Approval, Disburse, Undo Disbursal, Reject a Loan or Withdraw a Loan Application</h4> <h4>Approve, Undo Approval, Disburse, Undo Disbursal, Reject a Loan or Withdraw a Loan Application</h4>
<h5>Arguments</h5> <h5>Arguments</h5> <br>
<button type="button" onclick="showMandatoryFields('https://localhost:8443/mifosng-provider/api/v1/loans/37?command=approve', 'loan_state_transition_mandatory');">Show Mandatory Fields</button>
<br>
<div id=loan_state_transition_mandatory></div>
<br>
<dl class="argument-list"> <dl class="argument-list">
<dt>command</dt> <dt>command</dt>
<dd>String<span> Mandatory, case-insensitive</span></dd> <dd>String<span> Mandatory, case-insensitive</span></dd>
@@ -1552,15 +1557,16 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://thedomainname/api/v1/loans/{loanId}</code> <code class="method-declaration">POST https://thedomainname/api/v1/loans/{loanId}</code>
<code class="method-request">https://localhost:8443/mifosng-provider/api/v1/loans/1?command=approve <code class="method-request">POST https://localhost:8443/mifosng-provider/api/v1/loans/1?command=approve
Content-Type: application/json
Request Body:
Content-Type: application/json {
Request Body: "dateFormat": "dd MMMM yyyy",
new json here "eventDate": "07 May 2012",
</code> "note": "and event note is added"
} </code>
<code class="method-response">{ <code class="method-response">{
"entityId": 1 "entityId": 37
} }
</code> </code>
</div> </div>
+26 -17
View File
@@ -1,25 +1,21 @@
\loan\?\transactions\id get exception if loan doesn't match id.... should loan be taken out here? \loan\?\transactions\id get exception if loan doesn't match id.... should loan be taken out here?
template for waiver/repayment... is it same for both? no type needed? (might have got this wrong) template for waiver/repayment... is it same for both? no type needed? (might have got this wrong)
new loan template ... is it 2 templates... one to pick product... and 2nd to return default properties in selected product or is it meant that if only one product then use that. ---------------------------
recreate()
Lost permissions again... restore fixed it up... must be some prob with permissions/roles maintenance Lost permissions again... restore fixed it up... must be some prob with permissions/roles maintenance
also, maybe I should be using a user that has everything but role admin. also, maybe I should be using a user that has everything but role admin.
recreate() problem ME DO
list clients notes - noteType needs a 'text' DOING
createdOn & updatedOn values... do they need reformatting? DOING
updating client note - ignores clientId anyhow! so is it really a notes resource? DOING
list clients notes - noteType needs a 'text'TODO
createdOn & updatedOn values... do they need reformatting?TODO
updating client note - ignores clientId anyhow! so is it really a notes resource? TODO
loan template loan template
Formatted field still there Formatted field still there DOING
loan retrieve loan retrieve DOING
break up data into categories.. e.g. break up data into categories.. e.g.
Basic - lifeCycleStatusText thru Basic - lifeCycleStatusText thru
Convenience - open thru waitingForDisbursal then maxSubmittedOnOffsetFromToday, maxApprovedOnOffsetFromToday , maxDisbursedOnOffsetFromToday, actualLoanTermInDays, actualLoanTermInMonths, loanTermInDays, loanTermInMonths Convenience - open thru waitingForDisbursal then maxSubmittedOnOffsetFromToday, maxApprovedOnOffsetFromToday , maxDisbursedOnOffsetFromToday, actualLoanTermInDays, actualLoanTermInMonths, loanTermInDays, loanTermInMonths
@@ -30,20 +26,33 @@ repaymentSchedule
summary summary
loanRepayments loanRepayments
---------------------------------------------
LOAN TRANSITIONS approve etc.
if "eventLocalDate" parameter added with string date then instead of parameter not support msg do get jackson conversion exception.
approve loan (already closed) with approval date before submitted date
The server encountered an internal error () that prevented it from fulfilling this request.</u></p><p><b>exception</b> <pre>org.mifosng.platform.loan.domain.InvalidLoanTimelineDate: The date of when loan is approved cannot be before its submittal date.
approve loan (already closed) with approval date after submitted date
Column 'loan_status_id' cannot be null; SQL [n/a]; constraint [null]; nested exception is org.hibernate.exception.ConstraintViolationException: Column 'loan_status_id' cannot be null
if I do an approve when already approved also get
Column 'loan_status_id' cannot be null; SQL [n/a]; constraint [null]; nested exception is org.hibernate.exception.ConstraintViolationException: Column 'loan_status_id' cannot be null
somtimes client returns... always loanId OK?
---------------------------------------------------------
Additional Fields Additional Fields
put right message for parameter not recognized etc.(plus tht 9 other jpwwrongmsg items) put right message for parameter not recognized etc.(plus tht 9 other jpwwrongmsg items)
should be able to get clients by branch as well (but not for now) should be able to get clients by branch as well (but not for now)
also get loans of different status's by branch etc (but not for now)
Loans - what does Keith think about a description Loans - what does Keith think about a description
Identify Fields that need explaining Identify Fields that need explaining
Clients Clients
displayName, externalId, maxJoinedOnOffsetFromToday displayName, externalId, maxJoinedOnOffsetFromToday