From 4ce2013fac3a8f59cda84f1a441a4b7f2fa4cb05 Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Tue, 22 May 2012 22:58:38 +1000 Subject: [PATCH] api docs WIP --- APIFolder/api.htm | 78 +++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 69 insertions(+), 9 deletions(-) diff --git a/APIFolder/api.htm b/APIFolder/api.htm index b5ecf9e81..d79080853 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -797,30 +797,90 @@   +  
-

Retrieve Loan Repayment Template

-

Returns a template that contains client and loan product fields and allowed value lists. This helps build a maintenance User Interface. +

Retrieve Loan Repayment/Loan Waiver Template

+

Returns a template to help with entering loan repayments and waivers.

Arguments
type
-
String
-
The 'id' of the Client
-
productId
-
Integer
-
The 'id' of the Loan Product
+
String Optional, case-insensitive
+
The default action is to return details for Repayment of a loan. If the value is 'waiver' then details relevant to Waiving a loan amount are returned.

Example Request: - http://localhost:8080/mifosng-provider/api/v1/loans/template?clientId=1&productId=1 + http://localhost:8080/mifosng-provider/api/v1/loans/1/transactions/template?type=waiver"

- GET https://thedomainname/api/v1/loans/template + GET https://thedomainname/api/v1/loans/{loanId}/transactions/template" to be done
+   +   +
+
+

Make a Repayment / Loan Waiver

+
+
type
+
String Optional, case-insensitive
+
The default action is to make a Loan Repayment. If the value is 'waiver' then a Loan Waiver is made.
+
+
+
+ POST https://thedomainname/api/v1/loans/{loanId}/transactions + http://localhost:8080/mifosng-provider/api/v1/loans/1/transactions + + + Content-Type: application/json + Request Body: + new json here + + { + "entityId": 2 +} + +
+
+ +   +
+
+

Retrieve a Repayment's Details

+

Example Request: + http://localhost:8080/mifosng-provider/api/v1/loans/1/transactions/1 +

+
+
+ GET https://thedomainname/api/v1/loans/{loanId}/transactions/{repaymentId} + + +
+
+   +   +
+
+

Adjust a Repayment / Loan Waiver

+
+
+ POST https://thedomainname/api/v1/loans/{loanId}/transactions/{repaymentId} + http://localhost:8080/mifosng-provider/api/v1/loans/1/transactions/1 + + + Content-Type: application/json + Request Body: + new json here + + { + "entityId": 2 +} + +
+