From af1c75cf7b062f15eaf93cf676ff4814d9a9f78a Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Tue, 22 May 2012 18:16:09 +1000 Subject: [PATCH] api docs WIP --- APIFolder/api.htm | 144 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 143 insertions(+), 1 deletion(-) diff --git a/APIFolder/api.htm b/APIFolder/api.htm index d39b4d651..cf75c297a 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -429,6 +429,148 @@ + + +   +
+
+

Clients

+

Clients words. +

+
+
+ +
+
+
Attributes
+
+
+ id +
+
+ string jpw ipsum as an example of showing the (at least important) columns +
+
+ amount +
+
blah +
+
blah
+
+ card +
+
+
+
+ +   +
+
+

List Clients

+

Example Request: + http://localhost:8080/mifosng-provider/api/v1/clients +

+
+
+ GET https://thedomainname/api/v1/clients + to be done + +
+
+ + +   +
+
+

Retrieve Client Details Template

+

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

+

Example Request: + http://localhost:8080/mifosng-provider/api/v1/clients/template +

+
+
+ GET https://thedomainname/api/v1/clients/template + to be done + +
+
+ + +   +
+
+

Retrieve a Client

+

Returns client fields. It also returns allowed value lists which help build a maintenance User Interface. +

+

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

+
+
+ GET https://thedomainname/api/v1/clients/{clientId} + + +
+
+ + +   +
+
+

Create a Client

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

Retrieve a Client's Loan Account Summary

+

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

+
+
+ GET https://thedomainname/api/v1/clients/{clientId}/loans + + +
+
+   +
+
+

Retrieve a Client's Notes

+

Example Request: + http://localhost:8080/mifosng-provider/api/v1/clients/1/notes +

+
+
+ GET https://thedomainname/api/v1/clients/{clientId}/notes + + +
+
+ + + + + + + + + +  
@@ -506,7 +648,7 @@

- GET https://thedomainname/api/v1/loanproducts/{officeId} + GET https://thedomainname/api/v1/offices/{officeId}