diff --git a/api-docs/api.htm b/api-docs/apiLive - Copy.htm similarity index 80% rename from api-docs/api.htm rename to api-docs/apiLive - Copy.htm index e486bc103..47c843133 100644 --- a/api-docs/api.htm +++ b/api-docs/apiLive - Copy.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
@@ -163,7 +163,7 @@ The REST plugins will allow you to

Example Request:

- https://localhost:8443/mifosng-provider/api/v1/clients/template?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/template?pretty=true
GET https://thedomainname/api/v1/clients/template @@ -570,11 +567,11 @@ var jqxhr = $.ajax({

Retrieve a Client

Example Requests:

- https://localhost:8443/mifosng-provider/api/v1/clients/1?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true

- https://localhost:8443/mifosng-provider/api/v1/clients/1?pretty=true&template=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true&template=true

- https://localhost:8443/mifosng-provider/api/v1/clients/1?pretty=true&fields=id,displayName,officeName + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true&fields=id,displayName,officeName
GET https://thedomainname/api/v1/clients/{clientId} @@ -608,7 +605,7 @@ var jqxhr = $.ajax({
POST https://thedomainname/api/v1/clients -POST https://localhost:8443/mifosng-provider/api/v1/clients +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients Content-Type: application/json Request Body: { @@ -635,7 +632,7 @@ Request Body:
PUT https://thedomainname/api/v1/clients/{clientId} -PUT https://localhost:8443/mifosng-provider/api/v1/clients/23 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/23 Content-Type: application/json Request Body: { @@ -658,9 +655,9 @@ Request Body: However, it is quite reasonable to add resources like this to simplify User Interface development.

Example Requests:

- https://localhost:8443/mifosng-provider/api/v1/clients/1/loans?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?pretty=true

- https://localhost:8443/mifosng-provider/api/v1/clients/1/loans?pretty=true&fields=openLoans,%20closedLoans,activeLoanCount + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?pretty=true&fields=openLoans,%20closedLoans,activeLoanCount
GET https://thedomainname/api/v1/clients/{clientId}/notes @@ -756,7 +753,7 @@ Request Body:
POST https://thedomainname/api/v1/clients/{clientId}/notes - POST https://localhost:8443/mifosng-provider/api/v1/clients/1/notes + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/notes Content-Type: application/json Request Body: { @@ -775,9 +772,9 @@ Request Body:
GET https://thedomainname/api/v1/clients/{clientId}/notes/{noteId} @@ -806,7 +803,7 @@ Request Body:
PUT https://thedomainname/api/v1/clients/{clientId}/notes/{noteId} -PUT https://localhost:8443/mifosng-provider/api/v1/clients/2/notes/20 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20 Content-Type: application/json Request Body: { @@ -828,15 +825,14 @@ Request Body:

Loans

- - - - + - +
Field Descriptions
digitsAfterDecimal
Override the loan product default value for digitsAfterDecimal.
principal
Loan amount.
externalId
A place to put an external reference for this loan e.g. The ID another system uses.
A place to put an external reference for this loan e.g. The ID another system uses.
+ If provided, it must be unique.
inArrearsTolerance
The amount that can be 'waived' at end of all loan payments because it is too small to worry about.
+ This is also the tolerance amount assessed when determining if a loan is in arrears.
numberOfRepayments
Number of installments to repay.
Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType
@@ -896,9 +892,9 @@ Request Body:
If entered, productId, productName and selectedProduct fields are returned.

Example Requests:

- https://localhost:8443/mifosng-provider/api/v1/loans/template?clientId=1&productId=1&pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/template?clientId=1&productId=1&pretty=true

- https://localhost:8443/mifosng-provider/api/v1/loans/template?clientId=1&pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/template?clientId=1&pretty=true
GET https://thedomainname/api/v1/loans/{loanId} @@ -1483,7 +1479,7 @@ Request Body:  
-

Create a New Loan/Submit a Loan Application

+

Create a New Loan / Submit a Loan Application

Arguments
command
@@ -1503,7 +1499,7 @@ Request Body:
POST https://thedomainname/api/v1/loans - POST https://localhost:8443/mifosng-provider/api/v1/loans + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans Content-Type: application/json Request Body: { @@ -1557,7 +1553,7 @@ Request Body:
POST https://thedomainname/api/v1/loans/{loanId} - POST https://localhost:8443/mifosng-provider/api/v1/loans/1?command=approve + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?command=approve Content-Type: application/json Request Body: { @@ -1581,7 +1577,7 @@ Request Body:
DELETE https://thedomainname/api/v1/loans/{loanId} - DELETE https://localhost:8443/mifosng-provider/api/v1/loans/1 + DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1 Content-Type: application/json No Request Body: @@ -1611,10 +1607,11 @@ No Request Body: "total" "amount" is set to the amount outstanding.
'waiver'
"date" is set to the current date.
- "total" "amount" is set to the remaining loan principal outstanding.
+ "total" "amount" is set to the remaining loan principal outstanding. + The amount that can be waived is limited to the loan's inArrearsTolerance

Example Request:

- https://localhost:8443/mifosng-provider/api/v1/loans/10/transactions/template?command=repayment&pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/10/transactions/template?command=repayment&pretty=true
GET https://thedomainname/api/v1/loans/{loanId}/transactions/template" @@ -1648,7 +1645,7 @@ No Request Body:
POST https://thedomainname/api/v1/loans/{loanId}/transactions - POST https://localhost:8443/mifosng-provider/api/v1/loans/37/transactions?command=repayment + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/37/transactions?command=repayment Content-Type: application/json Request Body: { @@ -1671,7 +1668,7 @@ Request Body:
GET https://thedomainname/api/v1/loans/{loanId}/transactions/{transactionId} @@ -1710,7 +1707,7 @@ Request Body:
POST https://thedomainname/api/v1/loans/{loanId}/transactions/{transactionId} - POST https://localhost:8443/mifosng-provider/api/v1/loans/16/transactions/32 + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/16/transactions/32 Content-Type: application/json Request Body: { @@ -1740,8 +1737,8 @@ Request Body: - - + -
Field Descriptions
externalId
A place to put an external reference for this office e.g. The ID another system uses for it.
A place to put an external reference for this office e.g. The ID another system uses for it.
+ If provided, it must be unique.
hierarchy
This field is a system generated convenience field. It can't be set.
It uses "dot notation" to define where an office stands in the office hierarchy.
@@ -1750,7 +1747,6 @@ Request Body: And if a further office (id = 78) is placed directly under office (id = 12) its hierarchy value is '.12.78.'

The hierarchy value is useful when you need to display offices in 'hierarchy' order (perhaps indented in a drop down list box).
@@ -1760,9 +1756,9 @@ Request Body:
@@ -1834,16 +1830,16 @@ Request Body:
@@ -1872,7 +1868,7 @@ Request Body:
POST https://thedomainname/api/v1/offices -POST https://localhost:8443/mifosng-provider/api/v1/offices +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices Content-Type: application/json Request Body: { @@ -1897,7 +1893,7 @@ Request Body:
PUT https://thedomainname/api/v1/offices/{officeId} -PUT https://localhost:8443/mifosng-provider/api/v1/offices/1 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1 Content-Type: application/json Request Body: { @@ -1924,12 +1920,12 @@ Request Body: - - + - +
Field Descriptions
digitsAfterDecimal
Override the default value for digitsAfterDecimal associated with the currencyCode selected.
Override the currency default value for digitsAfterDecimal.
principal
Loan amount.
inArrearsTolerance
The amount that can be 'waived' at end of all loan payments because it is too small to worry about.
+ This is also the tolerance amount assessed when determining if a loan is in arrears.
numberOfRepayments
Number of installments to repay.
Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType
@@ -1974,9 +1970,9 @@ Request Body:
GET https://thedomainname/api/v1/loanproducts/template @@ -2266,11 +2262,11 @@ Request Body:
GET https://thedomainname/api/v1/loanproducts/{productId} @@ -2349,7 +2345,7 @@ Request Body:
POST https://thedomainname/api/v1/loanproducts -POST https://localhost:8443/mifosng-provider/api/v1/loanproducts +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts Content-Type: application/json Request Body: { @@ -2384,7 +2380,7 @@ Request Body:
POST https://thedomainname/api/v1/loanproducts/{loanId} -POST https://localhost:8443/mifosng-provider/api/v1/loanproducts/1 +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1 Content-Type: application/json Request Body: { @@ -2416,9 +2412,9 @@ Request Body:

Retrieve Currency Configuration

Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection).

Example Requests:

- https://localhost:8443/mifosng-provider/api/v1/configurations/currency?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?pretty=true

- https://localhost:8443/mifosng-provider/api/v1/configurations/currency?pretty=true&fields=selectedCurrencyOptions + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?pretty=true&fields=selectedCurrencyOptions
GET https://thedomainname/api/v1/configurations/currency @@ -2467,7 +2463,7 @@ Request Body:
PUT https://thedomainname/api/v1/configurations/currency - PUT https://localhost:8443/mifosng-provider/api/v1/configurations/currency + PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency Content-Type: application/json Request Body:{ "currencies": ["KES", "BND", "LBP", "GHC", "USD", "XOF", "AED", "AMD"] @@ -2528,9 +2524,9 @@ Request Body:{
The Additional Fields Type (Mifos X database table) to restrict the output to

Example Requests:

- https://localhost:8443/mifosng-provider/api/v1/additionalfields?type=portfolio_client&pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?type=portfolio_client&pretty=true

- https://localhost:8443/mifosng-provider/api/v1/additionalfields?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?pretty=true
GET https://thedomainname/api/v1/additionalfields @@ -2560,7 +2556,7 @@ Request Body:{ Returns the Set of Additional Fields data for the ID provided. The ID is the id field of the Type table e.g. portfolio_client might have an id value of 4. The output is a JSON formatted "Generic Resultset". The Generic Resultset contains Column Heading as well as Data information. The Column Heading information may include allowed values (columnValues array).

Example Request: - https://localhost:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2?pretty=true

@@ -2638,7 +2634,7 @@ Request Body:{
POST https://thedomainname/api/v1/additionalfields/{type}/{set}/{id} - POST https://localhost:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2 + POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2 Content-Type: application/json Request Body: { @@ -2697,9 +2693,9 @@ Request Body:
Output will be delivered as a CSV file instead of JSON.

Example Requests:

- https://localhost:8443/mifosng-provider/api/v1/reports?pretty=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?pretty=true

- https://localhost:8443/mifosng-provider/api/v1/reports?pretty=true&exportCSV=true + https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?pretty=true&exportCSV=true
GET https://thedomainname/api/v1/reports/{reportName} @@ -2927,7 +2923,7 @@ Request Body:
POST https://thedomainname/api/v1/authentication?username={username}&password={password} -POST https://localhost:8443/mifosng-provider/api/v1/authentication?username=super1&password=demo +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/authentication?username=super1&password=demo Content-Type: application/json No Request Body @@ -2961,9 +2957,9 @@ No Request Body
GET https://thedomainname/api/v1/users/template @@ -3061,11 +3057,11 @@ No Request Body
GET https://thedomainname/api/v1/users/1 @@ -3125,7 +3121,7 @@ No Request Body
POST https://thedomainname/api/v1/users -POST https://localhost:8443/mifosng-provider/api/v1/users +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users Content-Type: application/json Request body: { @@ -3153,7 +3149,7 @@ Request body:
PUT https://thedomainname/api/v1/users/{userId) -PUT https://localhost:8443/mifosng-provider/api/v1/users/3 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/3 Content-Type: application/json Request body: { @@ -3180,7 +3176,7 @@ Request body:
DELETE https://thedomainname/api/v1/users/{userId} -DELETE https://localhost:8443/mifosng-provider/api/v1/users/20 +DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/20 Content-Type: application/json No Request Body @@ -3207,9 +3203,9 @@ No Request Body
GET https://thedomainname/api/v1/roles/template @@ -3285,11 +3281,11 @@ No Request Body
GET https://thedomainname/api/v1/roles/{roleId} @@ -3334,7 +3330,7 @@ No Request Body
POST https://thedomainname/api/v1/roles -POST https://localhost:8443/mifosng-provider/api/v1/roles +POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles Content-Type: application/json Request body: { @@ -3357,7 +3353,7 @@ Request body:
PUT https://thedomainname/api/v1/roles/{roleId} -PUT https://localhost:8443/mifosng-provider/api/v1/roles/8 +PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/8 Content-Type: application/json Request body: { @@ -3387,9 +3383,9 @@ Request body:
GET https://thedomainname/api/v1/permissions @@ -3427,41 +3423,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/apiLive.htm b/api-docs/apiLive.htm index dc9566041..5359c5896 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -37,7 +37,7 @@
- + @@ -480,11 +480,8 @@ var jqxhr = $.ajax({
RESOURCES
POST
create/complex update
GET
read
PUT
update
DELETE
delete
CLIENTclientsCreate a ClientList Clients
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
- - - - - +
Field Descriptions
externalId
A place to put an external reference for this client e.g. The ID another system uses.
maxJoinedOnOffsetFromToday
Convenience field. Number of days since the Client joined.
A place to put an external reference for this client e.g. The ID another system uses.
+ If provided, it must be unique.
@@ -499,7 +496,7 @@ var jqxhr = $.ajax({ https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients?pretty=true&fields=displayName,officeName,joinedDate
- GET https://thedomainname/api/v1/clients + GET https://Domain Name/api/v1/clients [ { "officeId" : 1, "officeName" : "change super user", @@ -540,7 +537,7 @@ var jqxhr = $.ajax({ https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/template?pretty=true
- GET https://thedomainname/api/v1/clients/template + GET https://Domain Name/api/v1/clients/template { "joinedDate" : [ 2012, 5, 29 ], "allowedOffices" : [ { @@ -577,7 +574,7 @@ var jqxhr = $.ajax({ https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?pretty=true&fields=id,displayName,officeName
- GET https://thedomainname/api/v1/clients/{clientId} + GET https://Domain Name/api/v1/clients/{clientId} { "officeId" : 1, "officeName" : "change super user", @@ -599,7 +596,8 @@ var jqxhr = $.ajax({

Create a Client

Note: You can enter either:
firstname/lastname - for a person OR
- clientOrBusinessName - for a business or organisation (or person known by one name). + clientOrBusinessName - for a business or organisation (or person known by one name).

+ If you use clientOrBusinessName, the value is placed in the lastname field when you retrieve clients.

@@ -607,7 +605,7 @@ var jqxhr = $.ajax({
Mandatory Fields
- POST https://thedomainname/api/v1/clients + POST https://Domain Name/api/v1/clients POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients Content-Type: application/json Request Body: @@ -624,6 +622,24 @@ Request Body: { "entityId":23 } + +
+
+POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients +Content-Type: application/json +Request Body: +{ + "officeId": 1, + "clientOrBusinessName": "New Business to Create", + "externalId": "one/78", + "dateFormat": "dd MMMM yyyy", + "joiningDate": "13 June 2006" +} + + +{ + "entityId":26 +}
@@ -634,7 +650,7 @@ Request Body:

Update a Client

- PUT https://thedomainname/api/v1/clients/{clientId} + PUT https://Domain Name/api/v1/clients/{clientId} PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/23 Content-Type: application/json Request Body: @@ -663,7 +679,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?pretty=true&fields=openLoans,%20closedLoans,activeLoanCount
- GET https://thedomainname/api/v1/clients/{clientId}/loans + GET https://Domain Name/api/v1/clients/{clientId}/loans { "pendingApprovalLoans" : [ ], "awaitingDisbursalLoans" : [ { @@ -717,7 +733,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes?pretty=true&fields=note,createdOn,createdByUsername
- GET https://thedomainname/api/v1/clients/{clientId}/notes + GET https://Domain Name/api/v1/clients/{clientId}/notes [ { "id" : 20, "clientId" : 2, @@ -755,7 +771,7 @@ Request Body:

Add a Client Note

- POST https://thedomainname/api/v1/clients/{clientId}/notes + POST https://Domain Name/api/v1/clients/{clientId}/notes POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/notes Content-Type: application/json Request Body: @@ -780,7 +796,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20?pretty=true&fields=note,createdOn,createdByUsername
- GET https://thedomainname/api/v1/clients/{clientId}/notes/{noteId} + GET https://Domain Name/api/v1/clients/{clientId}/notes/{noteId} { "id" : 20, "clientId" : 2, @@ -805,7 +821,7 @@ Request Body:

Update a Client Note

- PUT https://thedomainname/api/v1/clients/{clientId}/notes/{noteId} + PUT https://Domain Name/api/v1/clients/{clientId}/notes/{noteId} PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20 Content-Type: application/json Request Body: @@ -828,15 +844,14 @@ Request Body:

Loans

- - - - + - +
Field Descriptions
digitsAfterDecimal
Override the loan product default value for digitsAfterDecimal.
principal
Loan amount.
externalId
A place to put an external reference for this loan e.g. The ID another system uses.
A place to put an external reference for this loan e.g. The ID another system uses.
+ If provided, it must be unique.
inArrearsTolerance
The amount that can be 'waived' at end of all loan payments because it is too small to worry about.
+ This is also the tolerance amount assessed when determining if a loan is in arrears.
numberOfRepayments
Number of installments to repay.
Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType
@@ -901,7 +916,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/template?clientId=1&pretty=true
- GET https://thedomainname/api/v1/loans/template + GET https://Domain Name/api/v1/loans/template { "clientId" : 1, "clientName" : "Patrick O'Meara", @@ -1096,7 +1111,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?pretty=true&fields=id,principal,interestRatePerYear
- GET https://thedomainname/api/v1/loans/{loanId} + GET https://Domain Name/api/v1/loans/{loanId} { "open" : false, "openWithRepaymentMade" : false, @@ -1502,7 +1517,7 @@ Request Body:
- POST https://thedomainname/api/v1/loans + POST https://Domain Name/api/v1/loans POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans Content-Type: application/json Request Body: @@ -1556,7 +1571,7 @@ Request Body:
- POST https://thedomainname/api/v1/loans/{loanId} + POST https://Domain Name/api/v1/loans/{loanId} POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?command=approve Content-Type: application/json Request Body: @@ -1580,7 +1595,7 @@ Request Body:

- DELETE https://thedomainname/api/v1/loans/{loanId} + DELETE https://Domain Name/api/v1/loans/{loanId} DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1 Content-Type: application/json No Request Body: @@ -1611,13 +1626,14 @@ No Request Body: "total" "amount" is set to the amount outstanding.
'waiver'
"date" is set to the current date.
- "total" "amount" is set to the remaining loan principal outstanding.
+ "total" "amount" is set to the remaining loan principal outstanding. + The amount that can be waived is limited to the loan's inArrearsTolerance

Example Request:

https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/10/transactions/template?command=repayment&pretty=true
- GET https://thedomainname/api/v1/loans/{loanId}/transactions/template" + GET https://Domain Name/api/v1/loans/{loanId}/transactions/template" { "date" : [ 2009, 8, 1 ], "total" : { @@ -1647,7 +1663,7 @@ No Request Body:
- POST https://thedomainname/api/v1/loans/{loanId}/transactions + POST https://Domain Name/api/v1/loans/{loanId}/transactions POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/37/transactions?command=repayment Content-Type: application/json Request Body: @@ -1674,7 +1690,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/10/transactions/20?pretty=true
- GET https://thedomainname/api/v1/loans/{loanId}/transactions/{transactionId} + GET https://Domain Name/api/v1/loans/{loanId}/transactions/{transactionId} { "id" : 10, "date" : [ 2009, 1, 29 ], @@ -1709,7 +1725,7 @@ Request Body:
- POST https://thedomainname/api/v1/loans/{loanId}/transactions/{transactionId} + POST https://Domain Name/api/v1/loans/{loanId}/transactions/{transactionId} POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/16/transactions/32 Content-Type: application/json Request Body: @@ -1740,8 +1756,8 @@ Request Body: - - + -
Field Descriptions
externalId
A place to put an external reference for this office e.g. The ID another system uses for it.
A place to put an external reference for this office e.g. The ID another system uses for it.
+ If provided, it must be unique.
hierarchy
This field is a system generated convenience field. It can't be set.
It uses "dot notation" to define where an office stands in the office hierarchy.
@@ -1750,7 +1766,6 @@ Request Body: And if a further office (id = 78) is placed directly under office (id = 12) its hierarchy value is '.12.78.'

The hierarchy value is useful when you need to display offices in 'hierarchy' order (perhaps indented in a drop down list box).
@@ -1765,7 +1780,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices?fields=id,name,openingDate&pretty=true
- GET https://thedomainname/api/v1/offices + GET https://Domain Name/api/v1/offices [ { "id" : 1, "name" : "Demo MFI Head Office", @@ -1811,7 +1826,7 @@ Request Body:
- GET https://thedomainname/api/v1/offices/template + GET https://Domain Name/api/v1/offices/template { "openingDate" : [ 2012, 5, 28 ], "allowedParents" : [ { @@ -1847,7 +1862,7 @@ Request Body:
- GET https://thedomainname/api/v1/offices/1 + GET https://Domain Name/api/v1/offices/1 { "id" : 1, "name" : "Demo MFI Head Office", @@ -1871,7 +1886,7 @@ Request Body:
- POST https://thedomainname/api/v1/offices + POST https://Domain Name/api/v1/offices POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices Content-Type: application/json Request Body: @@ -1896,7 +1911,7 @@ Request Body:

Update Office

- PUT https://thedomainname/api/v1/offices/{officeId} + PUT https://Domain Name/api/v1/offices/{officeId} PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1 Content-Type: application/json Request Body: @@ -1924,12 +1939,12 @@ Request Body: - - + - +
Field Descriptions
digitsAfterDecimal
Override the default value for digitsAfterDecimal associated with the currencyCode selected.
Override the currency default value for digitsAfterDecimal.
principal
Loan amount.
inArrearsTolerance
The amount that can be 'waived' at end of all loan payments because it is too small to worry about.
+ This is also the tolerance amount assessed when determining if a loan is in arrears.
numberOfRepayments
Number of installments to repay.
Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType
@@ -1979,7 +1994,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts?pretty=true&fields=name,description,interestRateFrequencyType,amortizationType
- GET https://thedomainname/api/v1/loanproducts + GET https://Domain Name/api/v1/loanproducts [ { "id" : 1, "name" : "Agricultural Loan", @@ -2113,7 +2128,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/template?pretty=true
- GET https://thedomainname/api/v1/loanproducts/template + GET https://Domain Name/api/v1/loanproducts/template { "principal" : { "currencyCode" : "KES", @@ -2273,7 +2288,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?pretty=true&fields=name,description,numberOfRepayments
- GET https://thedomainname/api/v1/loanproducts/{productId} + GET https://Domain Name/api/v1/loanproducts/{productId} { "id" : 1, "name" : "Agricultural Loan", @@ -2348,7 +2363,7 @@ Request Body:
- POST https://thedomainname/api/v1/loanproducts + POST https://Domain Name/api/v1/loanproducts POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts Content-Type: application/json Request Body: @@ -2383,7 +2398,7 @@ Request Body:

Update a Loan Product

- POST https://thedomainname/api/v1/loanproducts/{loanId} + POST https://Domain Name/api/v1/loanproducts/{loanId} POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1 Content-Type: application/json Request Body: @@ -2421,7 +2436,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?pretty=true&fields=selectedCurrencyOptions
- GET https://thedomainname/api/v1/configurations/currency + GET https://Domain Name/api/v1/configurations/currency { "selectedCurrencyOptions" : [ { "code" : "XOF", @@ -2466,7 +2481,7 @@ Request Body:

Updates the list of currencies permitted for use.

- PUT https://thedomainname/api/v1/configurations/currency + PUT https://Domain Name/api/v1/configurations/currency PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency Content-Type: application/json Request Body:{ @@ -2533,7 +2548,7 @@ Request Body:{ https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?pretty=true
- GET https://thedomainname/api/v1/additionalfields + GET https://Domain Name/api/v1/additionalfields [ { "id" : 1, "name" : "Additional Information", @@ -2564,7 +2579,7 @@ Request Body:{

- GET https://thedomainname/api/v1/additionalfields/{type}/{set}/{id} + GET https://Domain Name/api/v1/additionalfields/{type}/{set}/{id} { "columnHeaders" : [ { "columnName" : "Ethnic Group", @@ -2637,7 +2652,7 @@ Request Body:{

- POST https://thedomainname/api/v1/additionalfields/{type}/{set}/{id} + POST https://Domain Name/api/v1/additionalfields/{type}/{set}/{id} POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2 Content-Type: application/json Request Body: @@ -2702,7 +2717,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?pretty=true&exportCSV=true
- GET https://thedomainname/api/v1/reports + GET https://Domain Name/api/v1/reports { "columnHeaders" : [ { "columnName" : "report_id", @@ -2828,7 +2843,7 @@ Request Body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports/selectOfficeId?R_officeId=1&pretty=true& parameterType=true&exportCSV=true
- GET https://thedomainname/api/v1/reports/{reportName} + GET https://Domain Name/api/v1/reports/{reportName} { "columnHeaders" : [ { "columnName" : "Office/Branch", @@ -2926,7 +2941,7 @@ Request Body:

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

- POST https://thedomainname/api/v1/authentication?username={username}&password={password} + POST https://Domain Name/api/v1/authentication?username={username}&password={password} POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/authentication?username=super1&password=demo Content-Type: application/json No Request Body @@ -2966,7 +2981,7 @@ No Request Body https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users?pretty=true&fields=id,username,email,officeName
- GET https://thedomainname/api/v1/users + GET https://Domain Name/api/v1/users [ { "id" : 6, "officeId" : 1, @@ -3002,7 +3017,7 @@ No Request Body https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/template?pretty=true
- GET https://thedomainname/api/v1/users/template + GET https://Domain Name/api/v1/users/template { "allowedOffices" : [ { "id" : 1, @@ -3068,7 +3083,7 @@ No Request Body https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?pretty=true&fields=username,officeName
- GET https://thedomainname/api/v1/users/1 + GET https://Domain Name/api/v1/users/1 { "id" : 1, "officeId" : 1, @@ -3124,7 +3139,7 @@ No Request Body
- POST https://thedomainname/api/v1/users + POST https://Domain Name/api/v1/users POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users Content-Type: application/json Request body: @@ -3152,7 +3167,7 @@ Request body:

Note: When updating a password you must provide the repeatPassword parameter also.

- PUT https://thedomainname/api/v1/users/{userId) + PUT https://Domain Name/api/v1/users/{userId) PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/3 Content-Type: application/json Request body: @@ -3179,7 +3194,7 @@ Request body:

Removes the user and the associated roles and permissions.

- DELETE https://thedomainname/api/v1/users/{userId} + DELETE https://Domain Name/api/v1/users/{userId} DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/20 Content-Type: application/json No Request Body @@ -3212,7 +3227,7 @@ No Request Body https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles?pretty=true&fields=name
- GET https://thedomainname/api/v1/roles + GET https://Domain Name/api/v1/roles [ { "id" : 1, "name" : "Super user", @@ -3252,7 +3267,7 @@ No Request Body https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/template?pretty=true
- GET https://thedomainname/api/v1/roles/template + GET https://Domain Name/api/v1/roles/template { "availablePermissions" : [ { "id" : 1, @@ -3292,7 +3307,7 @@ No Request Body https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?pretty=true&fields=name,selectedPermissions
- GET https://thedomainname/api/v1/roles/{roleId} + GET https://Domain Name/api/v1/roles/{roleId} { "id" : 1, "name" : "Super user", @@ -3333,7 +3348,7 @@ No Request Body
- POST https://thedomainname/api/v1/roles + POST https://Domain Name/api/v1/roles POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles Content-Type: application/json Request body: @@ -3356,7 +3371,7 @@ Request body:

Update a Role

- PUT https://thedomainname/api/v1/roles/{roleId} + PUT https://Domain Name/api/v1/roles/{roleId} PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/8 Content-Type: application/json Request body: @@ -3392,7 +3407,7 @@ Request body: https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/permissions?pretty=true&fields=id,code
- GET https://thedomainname/api/v1/permissions + GET https://Domain Name/api/v1/permissions [ { "id" : 1, "name" : "User administration ALL", @@ -3424,10 +3439,10 @@ Request body:  


-

Full API Matrix

API Endpoint:

https://thedomainname/api
+

Full API Matrix

API Endpoint:

https://Domain Name/api
- + diff --git a/api-docs/docUpdateComments.txt b/api-docs/docUpdateComments.txt index 90bb13d0f..8778b4fad 100644 --- a/api-docs/docUpdateComments.txt +++ b/api-docs/docUpdateComments.txt @@ -58,30 +58,26 @@ DOCUMENTATION REMAINING Just Errors section to do in the Overview section -Identify Fields that need explaining -========================= -bit of loan product/loan -repayment/waiver - describe waiver -why fields "totalWaived", "overpaid" - - -take aout /v1 from resource name. - -maxJoinedOnOffsetFromToday +describe waiver CHECK RULES AFTER +why fields "totalWaived", "overpaid" - KW DOING - CHECK AFTER +maxJoinedOnOffsetFromToday - KW DOING - CHECK AFTER - 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? +no mention of it - done BUT NOTE displayName starts with space! + - TODO - check update of client with 'clientOrBusinessName' with -a first name/last name results in error +a first name/last name results in error - it just updates! NEED KEITH TO FIX - Loans - digitsAfterDecimal and currencyCode should NOT be sent during creation - they should be inherited from the product. Likewise for -update. +update. KW DOING - CHECK AFTER + - 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. +inherited from loan product. KW DOING - CHECK AFTER + +?DOMAIN NAME
RESOURCES
POST
create/complex update
GET
read
PUT
update
DELETE
delete
CLIENTclientsCreate a ClientList Clients
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