From 0acf904c0ed0005ff3f26bbb15791404176bc367 Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Mon, 28 May 2012 10:43:23 +1000 Subject: [PATCH] api docs update --- APIFolder/api.htm | 32 +++++++++++--------------------- APIFolder/docUpdateComments.txt | 12 +++++++++--- 2 files changed, 20 insertions(+), 24 deletions(-) diff --git a/APIFolder/api.htm b/APIFolder/api.htm index 42bc07402..4284ed818 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -114,9 +114,8 @@ /v1/loans/{loanId}/transactions/templateRetrieve Loan Repayment/Loan Waiver Template /v1/offices/templateRetrieve Office Details Template /v1/loanproducts/templateRetrieve Loan Product Details Template - /v1/useraccounts/current/password/templateRetrieve change password template - /v1/users/templateRetrieve new user template - /v1/roles/templateRetrieve new role template + /v1/users/templateRetrieve new user template + /v1/roles/templateRetrieve new role template @@ -149,7 +148,7 @@

Try The API From Your Browser

-

GET (read) examples can be run directly from this documentation. If you want to check out the POST, PUT and DELETE (update) examples you will need to +

GET (read) examples can be run directly from this documentation. If you want to check out the POST, PUT and DELETE (update) examples a good approach is to install a REST plugin for your browser e.g. RESTClient for FireFox

The REST plugins will allow you to
    @@ -1974,13 +1973,7 @@ Request Body:  
    -

    Create Office

    -

    Create an office.

    -

    Example Request: - - https://localhost:8443/mifosng-provider/api/v1/offices - -

    +

    Create an Office

    POST https://thedomainname/api/v1/offices @@ -1988,15 +1981,13 @@ Request Body: Content-Type: application/json Request Body: { - "name": "Demo branch 9", - "externalId": "9", - "dateFormat": "dd MMMM yyyy", - "openingDateFormatted": "01 September 2011", - "parentId": 1 + "name": "Example New Branch", + "dateFormat": "dd MMMM yyyy", + "openingDateFormatted": "01 July 2007", + "parentId": 2 } - -{ +{ "entityId": 9 } @@ -3752,9 +3743,8 @@ Request body: /v1/loans/{loanId}/transactions/templateRetrieve Loan Repayment/Loan Waiver Template /v1/offices/templateRetrieve Office Details Template /v1/loanproducts/templateRetrieve Loan Product Details Template - /v1/useraccounts/current/password/templateRetrieve change password template - /v1/users/templateRetrieve new user template - /v1/roles/templateRetrieve new role template + /v1/users/templateRetrieve new user template + /v1/roles/templateRetrieve new role template
    diff --git a/APIFolder/docUpdateComments.txt b/APIFolder/docUpdateComments.txt index 67215cf02..966b68cd9 100644 --- a/APIFolder/docUpdateComments.txt +++ b/APIFolder/docUpdateComments.txt @@ -1,13 +1,19 @@ \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? -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. +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. Configuration If you put a new currency config in and it deletes a currently in using { "selectedItems": ["USD", "GBP","XOF","ETB"] } then an exception report is returned Works fine using currencies (updated docs).... -also should this be a POST? and should it return just an ok and empty set rather than empty notSelectedCurrencies and currencies should update only select currencies and not allow notSelectedCurrencies? +Offices +When creating new offices.. do i have to supply "dateFormat": & "openingDateFormatted" for openingDate? What is list of dateFormats? +openingDate seems mandatory... but when the 'pair' not supplied I get NullPointerException +could just openingDate be used? +Note that openingData is passed as openingDateFormatted and a dateFormat is provided to convert the date from the way your UI records it to a common format. + +