diff --git a/APIFolder/api.htm b/APIFolder/api.htm index 41c759cea..82de72b4d 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -11,7 +11,7 @@
-

Overview

+

API Overview

@@ -19,6 +19,7 @@
  • Mifos X API Documentation
  • Authentication Overview
  • Errors
    • +
  • Full API Matrix
    • @@ -51,10 +52,10 @@

    Configuration

    -
    +
    - +
    Resources
    POST
    create/update
    GET
    read
    PUT
    simple update
    DELETE
    delete
    CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
    CONFIGURATION/v1/configurations/currency-Retrieve Currency ConfigurationUpdate Currency Configuration-
    @@ -62,7 +63,7 @@

    Additional Fields

    -
    +
    @@ -74,7 +75,7 @@

    Report

    -
    +
    Resources
    POST
    create/update
    GET
    read
    PUT
    simple update
    DELETE
    delete
    ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
    @@ -86,7 +87,7 @@

    User Related

    -
    +
    Resources
    POST
    create/update
    GET
    read
    PUT
    simple update
    DELETE
    delete
    REPORT/v1/reports-List Reports--
    @@ -102,9 +103,9 @@
    -

    Convenience API

    +

    Convenience

    -
    +
    Resources
    POST
    create/update
    GET
    read
    PUT
    simple update
    DELETE
    delete
    AUTHENTICATION/v1/authenticationVerify Authentication---
    @@ -121,55 +122,7 @@ -
    -
    -
    Convenience Resources
    GET
    read
    /v1/clients/templateRetrieve Client Details Template
    Mifos X API Endpoint:
    https://thedomainname/api
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Resources
    POST
    create/update
    GET
    read
    PUT
    simple update
    DELETE
    delete
    CLIENT/v1/clientsCreate a ClientList Clients--
    /v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
    /v1/clients/{clientId}/loans-Retrieve 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, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
    /v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
    /v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
    /v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
    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/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
    ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
    /v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields--
    REPORT/v1/reports-List Reports--
    /v1/reports/{reportName}-Run a Report--
    AUTHENTICATION/v1/authenticationVerify Authentication---
    USER ACCOUNT/v1/useraccounts/current-Retrieve Current Users' Account DetailsUpdate Current Users' Account Details-
    /v1/useraccounts/current/password--Update Current Users' Password-
    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/permissions-List 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/useraccounts/current/password/templateRetrieve change password template
    /v1/users/templateRetrieve new user template
    /v1/roles/templateRetrieve new role template
    - - -  
    @@ -2485,7 +2438,7 @@ Request Body:  
    -

    Retrieve currency configuration settings

    +

    Retrieve Currency Configuration

    Returns the list of selectedCurrencies that are allowed within the MFI and the list of currencies that are currently not selected.

    Example Request: https://localhost:8443/mifosng-provider/api/v1/configurations/currency @@ -2589,7 +2542,7 @@ Request Body:  

    -

    Update currency configuration settings

    +

    Update Currency Configuration

    Update list of selectedCurrencies that are allowed within the MFI and the list of currencies that are currently not selected.

    Example Request: https://localhost:8443/mifosng-provider/api/v1/configurations/currency @@ -4013,6 +3966,56 @@ Request body:

    + + +   +
    +

    + +

    Full API Matrix

    Mifos X API Endpoint:
    https://thedomainname/api
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Resources
    POST
    create/update
    GET
    read
    PUT
    simple update
    DELETE
    delete
    CLIENT/v1/clientsCreate a ClientList Clients--
    /v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
    /v1/clients/{clientId}/loans-Retrieve 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, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
    /v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
    /v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
    /v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
    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/currency-Retrieve Currency ConfigurationUpdate Currency Configuration-
    ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
    /v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields--
    REPORT/v1/reports-List Reports--
    /v1/reports/{reportName}-Run a Report--
    AUTHENTICATION/v1/authenticationVerify Authentication---
    USER ACCOUNT/v1/useraccounts/current-Retrieve Current Users' Account DetailsUpdate Current Users' Account Details-
    /v1/useraccounts/current/password--Update Current Users' Password-
    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/permissions-List 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/useraccounts/current/password/templateRetrieve change password template
    /v1/users/templateRetrieve new user template
    /v1/roles/templateRetrieve new role template
    +
    diff --git a/APIFolder/apicss/apidocs.css b/APIFolder/apicss/apidocs.css index 438a83c45..d908c83d0 100644 --- a/APIFolder/apicss/apidocs.css +++ b/APIFolder/apicss/apidocs.css @@ -1,5 +1,5 @@ .tocMatrix { - font-size: 75%; + font-size: 85%; } .matrixHeading {