From bc4999e254b028a4364ba457e6b1256d049fbd9d Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Mon, 28 May 2012 11:58:59 +1000 Subject: [PATCH] api docs update --- APIFolder/api.htm | 47 ++++++++++++++++++++++----------- APIFolder/docUpdateComments.txt | 11 ++++---- 2 files changed, 37 insertions(+), 21 deletions(-) diff --git a/APIFolder/api.htm b/APIFolder/api.htm index 4284ed818..a23753a92 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -20,6 +20,7 @@
  • Mifos X API Documentation
  • Try The API From Your Browser
  • Generic Options
    • +
  • Updating Dates and Numbers
  • Authentication Overview
  • Errors
  • Full API Matrix
    • @@ -190,6 +191,18 @@ + +   +
    +
    +

    Updating Dates and Numbers

    +

    Dates

    +

    Put in thing about suppying date_format and 'Formatted' being added onto end of field

    +

    Numbers

    +

    Put in whatever happens to numbers here.

    +
    + +
     
    @@ -2011,16 +2024,11 @@ Request Body: Content-Type: application/json Request Body: { - "name": "Demo branch 9 changed", - "externalId": "11", - "dateFormat": "dd MMMM yyyy", - "openingDateFormatted": "05 September 2011", - "parentId": 1 + "name": "Name is updated" } - -{ - "entityId": 9 +{ + "entityId": 1 }
    @@ -2933,17 +2941,26 @@ Request Body:

    Verify authentication

    -

    Verifies that the credentials provided successfully authenticate and returns the set of permissions allowed by that user.

    -

    Example Request: - https://localhost:8443/mifosng-provider/api/v1/authentication?username=super1&password=demo -

    +

    Authenticates the credentials provided and returns the set of permissions allowed.

    - POST https://thedomainname/api/v1/authentication?username=super1&password=demo + POST https://thedomainname/api/v1/authentication?username={userName}&password={password} POST https://localhost:8443/mifosng-provider/api/v1/authentication?username=super1&password=demo -Content-Type: application/xml +Content-Type: application/json +No Request Body - +{ + "username": "super1", + "userId": 2, + "base64EncodedAuthenticationKey": "c3VwZXIxOmRlbW8=", + "authenticated": true, + "permissions": [ + "USER_ADMINISTRATION_SUPER_USER_ROLE", + "REPORTING_SUPER_USER_ROLE", + "PORTFOLIO_MANAGEMENT_SUPER_USER_ROLE", + "ORGANISATION_ADMINISTRATION_SUPER_USER_ROLE" + ] +}
    diff --git a/APIFolder/docUpdateComments.txt b/APIFolder/docUpdateComments.txt index 966b68cd9..05ef45c97 100644 --- a/APIFolder/docUpdateComments.txt +++ b/APIFolder/docUpdateComments.txt @@ -3,17 +3,16 @@ template for waiver/repayment... is it same for both? no type needed? (might hav 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).... -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? +All Good! - -Offices +Offices (creates and updates not working with last commit) 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. +hierarchy update results in exception (prob solved by using unrecognized parameter exception)