From e8b8e362b8abdacdf7da3ad9be2804aecb88df1e Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Wed, 6 Jun 2012 16:48:53 +1000 Subject: [PATCH] api docs update --- api-docs/apiLive.htm | 126 ++++++++++++++++----------------- api-docs/docUpdateComments.txt | 36 +++++++--- 2 files changed, 90 insertions(+), 72 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index c3c739cc3..dc9566041 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -37,19 +37,19 @@
- - - - - - - - - - - - - + + + + + + + + + + + + +
RESOURCES
POST
create/complex update
GET
read
PUT
update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients
/v1/clients/{clientId}Retrieve a ClientUpdate a Client
/v1/clients/{clientId}/loansRetrieve a Client's Loan Account Summary
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes
/v1/clients/{clientId}/notes/{noteId}Retrieve a Client NoteUpdate a Client Note
LOAN/v1/loansCreate a New Loan/Submit a Loan Application
/v1/loans/{loanId}Approve, Undo Approval, Disburse, Undo Disbursal, Reject a Loan or Withdraw a Loan ApplicationRetrieve a LoanDelete a Loan
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver
/v1/loans/{loanId}/transactions/{transactionId}Adjust a Repayment or WaiverRetrieve a Repayment or Waiver Details
OFFICE/v1/officesCreate an OfficeList Offices
/v1/offices/{officeId}Retrieve an OfficeUpdate an Office
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products
/v1/loanproducts/{productId}Retrieve a Loan ProductUpdate a Loan Product
CLIENTclientsCreate a ClientList Clients
clients/{clientId}Retrieve a ClientUpdate a Client
clients/{clientId}/loansRetrieve a Client's Loan Account Summary
clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes
clients/{clientId}/notes/{noteId}Retrieve a Client NoteUpdate a Client Note
LOANloansCreate a New Loan / Submit a Loan Application
loans/{loanId}Approve, Undo Approval, Disburse, Undo Disbursal, Reject a Loan or Withdraw a Loan ApplicationRetrieve a LoanDelete a Loan
loans/{loanId}/transactionsMake a Repayment / Loan Waiver
loans/{loanId}/transactions/{transactionId}Adjust a Repayment or WaiverRetrieve a Repayment or Waiver Details
OFFICEofficesCreate an OfficeList Offices
offices/{officeId}Retrieve an OfficeUpdate an Office
LOAN PRODUCTloanproductsCreate a Loan ProductList Loan Products
loanproducts/{productId}Retrieve a Loan ProductUpdate a Loan Product
@@ -60,7 +60,7 @@
- +
RESOURCES
POST
create/complex update
GET
read
PUT
update
DELETE
delete
CONFIGURATION/v1/configurations/currencyRetrieve Currency ConfigurationUpdate Currency Configuration
CONFIGURATIONconfigurations/currencyRetrieve Currency ConfigurationUpdate Currency Configuration
@@ -71,8 +71,8 @@
- - + +
RESOURCES
POST
create/complex update
GET
read
PUT
update
DELETE
delete
ADDITIONAL FIELDS/v1/additionalfieldsList Additional Fields Sets
/v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields
ADDITIONAL FIELDSadditionalfieldsList Additional Fields Sets
additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields
@@ -83,8 +83,8 @@
- - + +
RESOURCES
POST
create/complex update
GET
read
PUT
update
DELETE
delete
REPORT/v1/reportsList Reports
/v1/reports/{reportName}Run a Report
REPORTreportsList Reports
reports/{reportName}Run a Report
@@ -95,12 +95,12 @@
- - - - - - + + + + + +
RESOURCES
POST
create/complex update
GET
read
PUT
update
DELETE
delete
AUTHENTICATION/v1/authenticationVerify Authentication
USER/v1/usersCreate a UserList Users
/v1/users/{userId}Retrieve a UserUpdate a UserDelete a User
ROLE/v1/rolesCreate a New RoleList Roles
/v1/roles/{roleId}Retrieve a RoleUpdate a Role
PERMISSION/v1/permissionsList Application Permissions
AUTHENTICATIONauthenticationVerify Authentication
USERusersCreate a UserList Users
users/{userId}Retrieve a UserUpdate a UserDelete a User
ROLErolesCreate a New RoleList Roles
roles/{roleId}Retrieve a RoleUpdate a Role
PERMISSIONpermissionsList Application Permissions
@@ -111,13 +111,13 @@
- - - - - - - + + + + + + +
RESOURCES
GET
read
/v1/clients/templateRetrieve Client Details Template
/v1/loans/templateRetrieve Loan Details Template
/v1/loans/{loanId}/transactions/templateRetrieve Loan Repayment/Loan Waiver Template
/v1/offices/templateRetrieve Office Details Template
/v1/loanproducts/templateRetrieve Loan Product Details Template
/v1/users/templateRetrieve User Details Template
/v1/roles/templateRetrieve Role Details Template
clients/templateRetrieve Client Details Template
loans/templateRetrieve Loan Details Template
loans/{loanId}/transactions/templateRetrieve Loan Repayment/Loan Waiver Template
offices/templateRetrieve Office Details Template
loanproducts/templateRetrieve Loan Product Details Template
users/templateRetrieve User Details Template
roles/templateRetrieve Role Details Template
@@ -1483,7 +1483,7 @@ Request Body:  
-

Create a New Loan/Submit a Loan Application

+

Create a New Loan / Submit a Loan Application

Arguments
command
@@ -3427,41 +3427,41 @@ Request body:

Full API Matrix

API Endpoint:

https://thedomainname/api
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +
RESOURCES
POST
create/complex update
GET
read
PUT
update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients
/v1/clients/{clientId}Retrieve a ClientUpdate a Client
/v1/clients/{clientId}/loansRetrieve a Client's Loan Account Summary
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes
/v1/clients/{clientId}/notes/{noteId}Retrieve a Client NoteUpdate a Client Note
LOAN/v1/loansCreate a New Loan/Submit a Loan Application
/v1/loans/{loanId}Approve, Undo Approval, Disburse, Undo Disbursal, Reject a Loan or Withdraw a Loan ApplicationRetrieve a LoanDelete a Loan
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver
/v1/loans/{loanId}/transactions/{transactionId}Adjust a Repayment or WaiverRetrieve a Repayment or Waiver Details
OFFICE/v1/officesCreate an OfficeList Offices
/v1/offices/{officeId}Retrieve an OfficeUpdate an Office
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products
/v1/loanproducts/{productId}Retrieve a Loan ProductUpdate a Loan Product
CONFIGURATION/v1/configurations/currencyRetrieve Currency ConfigurationUpdate Currency Configuration
ADDITIONAL FIELDS/v1/additionalfieldsList Additional Fields Sets
/v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields
REPORT/v1/reportsList Reports
/v1/reports/{reportName}Run a Report
AUTHENTICATION/v1/authenticationVerify Authentication
USER/v1/usersCreate a UserList Users
/v1/users/{userId}Retrieve a UserUpdate a UserDelete a User
ROLE/v1/rolesCreate a New RoleList Roles
/v1/roles/{roleId}Retrieve a RoleUpdate a Role
PERMISSION/v1/permissionsList Application Permissions
CLIENTclientsCreate a ClientList Clients
clients/{clientId}Retrieve a ClientUpdate a Client
clients/{clientId}/loansRetrieve a Client's Loan Account Summary
clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes
clients/{clientId}/notes/{noteId}Retrieve a Client NoteUpdate a Client Note
LOANloansCreate a New Loan / Submit a Loan Application
loans/{loanId}Approve, Undo Approval, Disburse, Undo Disbursal, Reject a Loan or Withdraw a Loan ApplicationRetrieve a LoanDelete a Loan
loans/{loanId}/transactionsMake a Repayment / Loan Waiver
loans/{loanId}/transactions/{transactionId}Adjust a Repayment or WaiverRetrieve a Repayment or Waiver Details
OFFICEofficesCreate an OfficeList Offices
offices/{officeId}Retrieve an OfficeUpdate an Office
LOAN PRODUCTloanproductsCreate a Loan ProductList Loan Products
loanproducts/{productId}Retrieve a Loan ProductUpdate a Loan Product
CONFIGURATIONconfigurations/currencyRetrieve Currency ConfigurationUpdate Currency Configuration
ADDITIONAL FIELDSadditionalfieldsList Additional Fields Sets
additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields
REPORTreportsList Reports
reports/{reportName}Run a Report
AUTHENTICATIONauthenticationVerify Authentication
USERusersCreate a UserList Users
users/{userId}Retrieve a UserUpdate a UserDelete a User
ROLErolesCreate a New RoleList Roles
roles/{roleId}Retrieve a RoleUpdate a Role
PERMISSIONpermissionsList Application Permissions

- - - - - - - + + + + + + +
CONVENIENCE RESOURCES
GET
read
/v1/clients/templateRetrieve Client Details Template
/v1/loans/templateRetrieve Loan Details Template
/v1/loans/{loanId}/transactions/templateRetrieve Loan Repayment/Loan Waiver Template
/v1/offices/templateRetrieve Office Details Template
/v1/loanproducts/templateRetrieve Loan Product Details Template
/v1/users/templateRetrieve User Details Template
/v1/roles/templateRetrieve Role Details Template
clients/templateRetrieve Client Details Template
loans/templateRetrieve Loan Details Template
loans/{loanId}/transactions/templateRetrieve Loan Repayment/Loan Waiver Template
offices/templateRetrieve Office Details Template
loanproducts/templateRetrieve Loan Product Details Template
users/templateRetrieve User Details Template
roles/templateRetrieve Role Details Template
diff --git a/api-docs/docUpdateComments.txt b/api-docs/docUpdateComments.txt index 53a654904..90bb13d0f 100644 --- a/api-docs/docUpdateComments.txt +++ b/api-docs/docUpdateComments.txt @@ -4,7 +4,7 @@ POSSIBLE CHANGES TO APP OR DOCUMENTATION list clients notes - noteType needs a 'text' DOING createdOn & updatedOn values... do they need reformatting? DOING -loan template - repaymentSchedule is null - I can't see it set in the app - used in preview schedule functionality maybe? +loan template - repaymentSchedule is null - I can't see it set in the app - used in preview schedule functionality maybe? - probably not used and will be deleted loan retrieve DOING @@ -18,7 +18,7 @@ loan retrieve DOING loanRepayments -Loan Transitions ... approve etc +Loan Transitions ... approve etc - possible done 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.

exception 

org.mifosng.platform.loan.domain.InvalidLoanTimelineDate: The     date    of when loan is approved cannot be before its submittal date.
@@ -30,20 +30,18 @@ Loan Transitions ... approve etc
    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
 
 
-   sometimes clientId returned... always loanId OK?
+   sometimes clientId returned... always loanId OK? DOING
 
 
 Loan Transactions (repay and waive - and maybe reversal - but not disbursement) general talk needed as retrieve could work for any txn?
     transaction type... UNKNOWN(0), DISBURSEMENT(1), REPAYMENT(2), REVERSAL(3), WAIVED(4);
     Create - (command has string and proper value fields... so assume its like eventDate above)
 
-    Template - does waiver amount default to 'rest of loan' cos it looked like it missed out on other waivers. didn't test
-	repayment amount matches current installment outstanding amount w/o taking waivers into account.
-    check descriptions - couldn't test because of invalid locale
-    retrieve: display transaction type value?
-    "principal" : null,   "interest" : null, total, "totalWaived" : null,   "overpaid" : null, and the offset - are nulls ever put in?
+    retrieve: display transaction type value?  DOING
+    "principal" : null,   "interest" : null, total, "totalWaived" : null,   "overpaid" : null, and the offset - are nulls ever put in? DOING
     adjust:
-    when adjusting a disbursal - The server encountered an internal error () that prevented it from fulfilling this request.
exception 
java.lang.IllegalArgumentException:         Only repayment and waiver transactions can be adjusted.
+
+    when adjusting a disbursal - The server encountered an internal error () that prevented it from fulfilling this request.
exception 
java.lang.IllegalArgumentException:         Only repayment and waiver transactions can be adjusted. DONE
     on create and adjust, app returns clientId can it be transaction id or loanId?
 
 
@@ -67,3 +65,23 @@ bit of loan product/loan
 repayment/waiver - describe waiver
 why fields "totalWaived", "overpaid"
 
+
+take aout /v1 from resource name.
+
+maxJoinedOnOffsetFromToday
+
+    - create a client example could show second example with the
+field clientOrBusinessName being used instead of firstname, lastname,
+no mention of it.
+    - mention if optional externalId is provided, it must be unqiue?
+    - TODO - check update of client with 'clientOrBusinessName' with
+a first name/last name results in error
+
+ - Loans
+     - digitsAfterDecimal and currencyCode should NOT be sent during
+creation - they should be inherited from the product. Likewise for
+update.
+     - Would be better if it was possible to not pass any of these
+details if defaults from loan product are acceptable, they can be
+inherited from loan product.
+