api docs WIP

This commit is contained in:
John Woodlock
2012-05-21 21:12:04 +10:00
parent 5a72f687e7
commit 69722c9409
+474 -313
View File
@@ -1,8 +1,10 @@
<!DOCTYPE html> <!DOCTYPE html>
<html><head> <html>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"> <head>
<link rel="stylesheet" href="apicss/apidocs.css" type="text/css" media="screen" title="Mifos X API Docs" charset="utf-8"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<link rel="stylesheet" href="apicss/apidocs.css" type="text/css" media="screen" title="Mifos X API Docs" charset="utf-8"/>
<title>Mifos X API Documentation</title> <title>Mifos X API Documentation</title>
</head>
<body> <body>
@@ -67,7 +69,6 @@ is there a retrieve waive and an Adjust Waiver as well?
<div class="toc-column3"> <div class="toc-column3">
<div class="toc-section"> <div class="toc-section">
<h4><a href="#offices">Offices</a></h4> <h4><a href="#offices">Offices</a></h4>
<ul> <ul>
@@ -149,14 +150,13 @@ is there a retrieve waive and an Adjust Waiver as well?
</ul> </ul>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<a id="top" name="top" class="old-syle-anchor">&nbsp;</a>
<div id="main-content-wrapper"> <div id="main-content-wrapper">
<a id="top" name="top" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h1>Mifos X API Documentation</h1> <h1>Mifos X API Documentation</h1>
@@ -280,7 +280,6 @@ the examples on the page, so you can test out any example right away.
<a id="errors" name="errors" class="old-syle-anchor">&nbsp;</a> <a id="errors" name="errors" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h3>Errors</h3> <h3>Errors</h3>
<p>JPW:Need to update this <p>JPW:Need to update this
Stripe uses conventional HTTP response codes to indicate Stripe uses conventional HTTP response codes to indicate
@@ -416,15 +415,11 @@ error is parameter-specific. You can use this to display a message near
<a id="offices" name="offices" class="old-syle-anchor">&nbsp;</a>
<a id="loanproducts" name="loanproducts" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h3>Loan Products</h3> <h3>Offices</h3>
<p>A Loan product is a template that is used when creating a loan. Much of the template definition can be changed during loan creation. <p>The Office and Branch hierarchy.
</p> </p>
</div> </div>
</div> </div>
@@ -442,281 +437,45 @@ error is parameter-specific. You can use this to display a message near
<dt> <dt>
amount amount
</dt> </dt>
<dd>positive integer or zero <span></span> <dd>blah <span></span>
</dd> </dd>
<dd>Amount charged in cents</dd> <dd>blah</dd>
<dt> <dt>
card card
</dt> </dt>
<dd>
<dd><strong>hash</strong></dd>
<dd>
Hash describing the card used to make the charge
<dl class="argument-list">
<dt>
inner object
</dt>
<dd>inner string <span> inner span extra </span>
</dd>
</dl> </dl>
</dd>
<dt>
fingerprint
</dt>
<dd>string<span> or something</span>
</dd>
</dl>
</div> </div>
</div> </div>
<a id="offices_list" name="offices_list" class="old-syle-anchor">&nbsp;</a>
<a id="loanproducts_list" name="loanproducts_list" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>List Loan Products</h4> <h4>List Offices (and Branches)</h4>
<p>Example Request: <p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts">http://localhost:8080/mifosng-provider/api/v1/loanproducts</a> <a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/offices">http://localhost:8080/mifosng-provider/api/v1/offices</a>
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts</code> <code class="method-declaration">GET https://thedomainname/api/v1/offices</code>
<code class="method-response"> { <code class="method-response"> to be done
"products": [
{
"id": 1,
"name": "Agricultural Loan",
"description": "An agricultural loan given to farmers to help buy crop, stock and machinery. With an arrears tolerance setting of 1,000 CFA, loans are not marked as 'in arrears' or 'in bad standing' if the amount outstanding is less than this. Interest rate is described using monthly percentage rate (MPR) even though the loan typically lasts a year and requires one repayment (typically at time when farmer sells crop)",
"principalMoney": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 100000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "100000 CFA"
},
"interestRatePerPeriod": 1.75,
"interestRatePeriod": 2,
"annualInterestRate": 21,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 0,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 12,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 1,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 1000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "1000 CFA"
},
"createdOn": "2012-04-12T00:00:00.000+10:00",
"lastModifedOn": "2012-04-12T00:00:00.000+10:00",
"possibleCurrencies": [],
"possibleAmortizationOptions": [],
"possibleInterestOptions": [],
"possibleInterestRateCalculatedInPeriodOptions": [],
"repaymentFrequencyOptions": [],
"interestFrequencyOptions": [],
"interestRebateAllowed": false,
"flexible": false
},
{
"id": 2,
"name": "curr loan",
"description": "asdff",
"principalMoney": {
"currencyCode": "ETB",
"currencyDigitsAfterDecimal": 2,
"amount": 100000,
"defaultName": "Ethiopian Birr",
"nameCode": "currency.ETB",
"displaySymbol": null,
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "100000.00 null"
},
"interestRatePerPeriod": 0,
"interestRatePeriod": 2,
"annualInterestRate": 0,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 0,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 1,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 5,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "ETB",
"currencyDigitsAfterDecimal": 2,
"amount": 0,
"defaultName": "Ethiopian Birr",
"nameCode": "currency.ETB",
"displaySymbol": null,
"zero": true,
"greaterThanZero": false,
"displaySymbolValue": "0.00 null"
},
"createdOn": "2012-04-15T00:00:00.000+10:00",
"lastModifedOn": "2012-04-15T00:00:00.000+10:00",
"possibleCurrencies": [],
"possibleAmortizationOptions": [],
"possibleInterestOptions": [],
"possibleInterestRateCalculatedInPeriodOptions": [],
"repaymentFrequencyOptions": [],
"interestFrequencyOptions": [],
"interestRebateAllowed": false,
"flexible": false
}
]
}
</code> </code>
</div> </div>
</div> </div>
<a id="loanproducts_template" name="loanproducts_template" class="old-syle-anchor">&nbsp;</a> <a id="offices_template" name="offices_template" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Retrieve Loan Product Details Template</h4> <h4>Retrieve Office Details Template</h4>
<p>Returns a template that contains the loan product fields and allowed value lists. This helps build a maintenance User Interface. <p>Returns a template that contains the office fields and allowed value lists. This helps build a maintenance User Interface.
</p> </p>
<p>Example Request: <p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts/template">http://localhost:8080/mifosng-provider/api/v1/loanproducts/template</a> <a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/offices/template">http://localhost:8080/mifosng-provider/api/v1/offices/template</a>
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/template</code> <code class="method-declaration">GET https://thedomainname/api/v1/offices/template</code>
<code class="method-response"> { <code class="method-response"> to be done
"id": null,
"name": null,
"description": null,
"principalMoney": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 0,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": true,
"greaterThanZero": false,
"displaySymbolValue": "0 CFA"
},
"interestRatePerPeriod": 0,
"interestRatePeriod": 2,
"annualInterestRate": 0,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 1,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 1,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 0,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 0,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": true,
"greaterThanZero": false,
"displaySymbolValue": "0 CFA"
},
"createdOn": null,
"lastModifedOn": null,
"possibleCurrencies": [
{
"code": "XOF",
"name": "CFA Franc BCEAO",
"decimalPlaces": 0,
"displaySymbol": "CFA",
"nameCode": "currency.XOF",
"displayLabel": "CFA Franc BCEAO (CFA)"
},
{
"code": "ETB",
"name": "Ethiopian Birr",
"decimalPlaces": 2,
"displaySymbol": null,
"nameCode": "currency.ETB",
"displayLabel": "Ethiopian Birr [ETB]"
}
],
"possibleAmortizationOptions": [
{
"id": 1,
"value": "Equal installments"
},
{
"id": 0,
"value": "Equal principle payments"
}
],
"possibleInterestOptions": [
{
"id": 0,
"value": "Declining Balance"
},
{
"id": 1,
"value": "Flat"
}
],
"possibleInterestRateCalculatedInPeriodOptions": [
{
"id": 0,
"value": "Daily"
},
{
"id": 1,
"value": "Same as repayment period"
}
],
"repaymentFrequencyOptions": [
{
"id": 0,
"value": "Days"
},
{
"id": 1,
"value": "Weeks"
},
{
"id": 2,
"value": "Months"
}
],
"interestFrequencyOptions": [
{
"id": 2,
"value": "Per month"
},
{
"id": 3,
"value": "Per year"
}
],
"interestRebateAllowed": false,
"flexible": false
}
</code> </code>
</div> </div>
</div> </div>
@@ -726,16 +485,13 @@ error is parameter-specific. You can use this to display a message near
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Retrieve a Loan Product</h4> <h4>Retrieve a Loan Product</h4>
<p>Returns loan product fields. It also returns allowed value lists which help build a maintenance User Interface. <p>Returns loan product fields. It also returns allowed value lists which help build a maintenance User Interface.
JPW - includes validation values (might be ok or option), enum? JPW - includes validation values (might be ok or option), enum?
</p> </p>
<p>Example Request: <p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts/1">http://localhost:8080/mifosng-provider/api/v1/loanproducts/1</a> <a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts/1">http://localhost:8080/mifosng-provider/api/v1/loanproducts/1</a>
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/{productId}</code> <code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/{productId}</code>
<code class="method-response"> { <code class="method-response"> {
@@ -861,7 +617,6 @@ JPW - includes validation values (might be ok or option), enum?
<div class="method-description"> <div class="method-description">
<h4>Create a Loan Product</h4> <h4>Create a Loan Product</h4>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://thedomainname/api/v1/loanproducts</code> <code class="method-declaration">POST https://thedomainname/api/v1/loanproducts</code>
<code class="method-request">http://localhost:8080/mifosng-provider/api/v1/loanproducts <code class="method-request">http://localhost:8080/mifosng-provider/api/v1/loanproducts
@@ -871,7 +626,455 @@ Content-Type: application/json
Request Body: Request Body:
new loan product json here new loan product json here
</code> </code>
</div>
</div>
<a id="loanproducts_update" name="loanproducts_update" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<a id="loanproducts" name="loanproducts" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>Loan Products</h3>
<p>A Loan product is a template that is used when creating a loan. Much of the template definition can be changed during loan creation.
</p>
</div>
</div>
<div class="method-section">
<div class="method-description">
<h5>Attributes</h5>
<dl class="argument-list">
<dt>
id
</dt>
<dd>
string <span>jpw ipsum as an example of showing the (at least important) columns</span>
</dd>
<dt>
amount
</dt>
<dd>positive integer or zero <span></span>
</dd>
<dd>Amount charged in cents</dd>
<dt>
card
</dt>
<dd>
<dd><strong>hash</strong></dd>
<dd>
Hash describing the card used to make the charge
<dl class="argument-list">
<dt>
inner object
</dt>
<dd>inner string <span> inner span extra </span>
</dd>
</dl>
</dd>
<dt>
fingerprint
</dt>
<dd>string<span> or something</span>
</dd>
</dl>
</div>
</div>
<a id="loanproducts_list" name="loanproducts_list" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>List Loan Products</h4>
<p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts">http://localhost:8080/mifosng-provider/api/v1/loanproducts</a>
</p>
</div>
<div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts</code>
<code class="method-response"> {
"products": [
{
"id": 1,
"name": "Agricultural Loan",
"description": "An agricultural loan given to farmers to help buy crop, stock and machinery. With an arrears tolerance setting of 1,000 CFA, loans are not marked as 'in arrears' or 'in bad standing' if the amount outstanding is less than this. Interest rate is described using monthly percentage rate (MPR) even though the loan typically lasts a year and requires one repayment (typically at time when farmer sells crop)",
"principalMoney": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 100000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "100000 CFA"
},
"interestRatePerPeriod": 1.75,
"interestRatePeriod": 2,
"annualInterestRate": 21,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 0,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 12,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 1,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 1000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "1000 CFA"
},
"createdOn": "2012-04-12T00:00:00.000+10:00",
"lastModifedOn": "2012-04-12T00:00:00.000+10:00",
"possibleCurrencies": [],
"possibleAmortizationOptions": [],
"possibleInterestOptions": [],
"possibleInterestRateCalculatedInPeriodOptions": [],
"repaymentFrequencyOptions": [],
"interestFrequencyOptions": [],
"interestRebateAllowed": false,
"flexible": false
},
{
"id": 2,
"name": "curr loan",
"description": "asdff",
"principalMoney": {
"currencyCode": "ETB",
"currencyDigitsAfterDecimal": 2,
"amount": 100000,
"defaultName": "Ethiopian Birr",
"nameCode": "currency.ETB",
"displaySymbol": null,
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "100000.00 null"
},
"interestRatePerPeriod": 0,
"interestRatePeriod": 2,
"annualInterestRate": 0,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 0,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 1,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 5,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "ETB",
"currencyDigitsAfterDecimal": 2,
"amount": 0,
"defaultName": "Ethiopian Birr",
"nameCode": "currency.ETB",
"displaySymbol": null,
"zero": true,
"greaterThanZero": false,
"displaySymbolValue": "0.00 null"
},
"createdOn": "2012-04-15T00:00:00.000+10:00",
"lastModifedOn": "2012-04-15T00:00:00.000+10:00",
"possibleCurrencies": [],
"possibleAmortizationOptions": [],
"possibleInterestOptions": [],
"possibleInterestRateCalculatedInPeriodOptions": [],
"repaymentFrequencyOptions": [],
"interestFrequencyOptions": [],
"interestRebateAllowed": false,
"flexible": false
}
]
}
</code>
</div>
</div>
<a id="loanproducts_template" name="loanproducts_template" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Retrieve Loan Product Details Template</h4>
<p>Returns a template that contains the loan product fields and allowed value lists. This helps build a maintenance User Interface.
</p>
<p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts/template">http://localhost:8080/mifosng-provider/api/v1/loanproducts/template</a>
</p>
</div>
<div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/template</code>
<code class="method-response"> {
"id": null,
"name": null,
"description": null,
"principalMoney": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 0,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": true,
"greaterThanZero": false,
"displaySymbolValue": "0 CFA"
},
"interestRatePerPeriod": 0,
"interestRatePeriod": 2,
"annualInterestRate": 0,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 1,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 1,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 0,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 0,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": true,
"greaterThanZero": false,
"displaySymbolValue": "0 CFA"
},
"createdOn": null,
"lastModifedOn": null,
"possibleCurrencies": [
{
"code": "XOF",
"name": "CFA Franc BCEAO",
"decimalPlaces": 0,
"displaySymbol": "CFA",
"nameCode": "currency.XOF",
"displayLabel": "CFA Franc BCEAO (CFA)"
},
{
"code": "ETB",
"name": "Ethiopian Birr",
"decimalPlaces": 2,
"displaySymbol": null,
"nameCode": "currency.ETB",
"displayLabel": "Ethiopian Birr [ETB]"
}
],
"possibleAmortizationOptions": [
{
"id": 1,
"value": "Equal installments"
},
{
"id": 0,
"value": "Equal principle payments"
}
],
"possibleInterestOptions": [
{
"id": 0,
"value": "Declining Balance"
},
{
"id": 1,
"value": "Flat"
}
],
"possibleInterestRateCalculatedInPeriodOptions": [
{
"id": 0,
"value": "Daily"
},
{
"id": 1,
"value": "Same as repayment period"
}
],
"repaymentFrequencyOptions": [
{
"id": 0,
"value": "Days"
},
{
"id": 1,
"value": "Weeks"
},
{
"id": 2,
"value": "Months"
}
],
"interestFrequencyOptions": [
{
"id": 2,
"value": "Per month"
},
{
"id": 3,
"value": "Per year"
}
],
"interestRebateAllowed": false,
"flexible": false
}
</code>
</div>
</div>
<a id="loanproducts_retrieve" name="loanproducts_retrieve" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Retrieve a Loan Product</h4>
<p>Returns loan product fields. It also returns allowed value lists which help build a maintenance User Interface.
JPW - includes validation values (might be ok or option), enum?
</p>
<p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts/1">http://localhost:8080/mifosng-provider/api/v1/loanproducts/1</a>
</p>
</div>
<div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/{productId}</code>
<code class="method-response"> {
"id": 1,
"name": "Agricultural Loan",
"description": "An agricultural loan given to farmers to help buy crop, stock and machinery. With an arrears tolerance setting of 1,000 CFA, loans are not marked as 'in arrears' or 'in bad standing' if the amount outstanding is less than this. Interest rate is described using monthly percentage rate (MPR) even though the loan typically lasts a year and requires one repayment (typically at time when farmer sells crop)",
"principalMoney": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 100000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "100000 CFA"
},
"interestRatePerPeriod": 1.75,
"interestRatePeriod": 2,
"annualInterestRate": 21,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 0,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 12,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 1,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 1000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "1000 CFA"
},
"createdOn": "2012-04-12T00:00:00.000+10:00",
"lastModifedOn": "2012-04-12T00:00:00.000+10:00",
"possibleCurrencies": [
{
"code": "XOF",
"name": "CFA Franc BCEAO",
"decimalPlaces": 0,
"displaySymbol": "CFA",
"nameCode": "currency.XOF",
"displayLabel": "CFA Franc BCEAO (CFA)"
},
{
"code": "ETB",
"name": "Ethiopian Birr",
"decimalPlaces": 2,
"displaySymbol": null,
"nameCode": "currency.ETB",
"displayLabel": "Ethiopian Birr [ETB]"
}
],
"possibleAmortizationOptions": [
{
"id": 1,
"value": "Equal installments"
},
{
"id": 0,
"value": "Equal principle payments"
}
],
"possibleInterestOptions": [
{
"id": 0,
"value": "Declining Balance"
},
{
"id": 1,
"value": "Flat"
}
],
"possibleInterestRateCalculatedInPeriodOptions": [
{
"id": 0,
"value": "Daily"
},
{
"id": 1,
"value": "Same as repayment period"
}
],
"repaymentFrequencyOptions": [
{
"id": 0,
"value": "Days"
},
{
"id": 1,
"value": "Weeks"
},
{
"id": 2,
"value": "Months"
}
],
"interestFrequencyOptions": [
{
"id": 2,
"value": "Per month"
},
{
"id": 3,
"value": "Per year"
}
],
"interestRebateAllowed": false,
"flexible": false
}
</code>
</div>
</div>
<a id="loanproducts_create" name="loanproducts_create" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Create a Loan Product</h4>
</div>
<div class="method-example">
<code class="method-declaration">POST https://thedomainname/api/v1/loanproducts</code>
<code class="method-request">http://localhost:8080/mifosng-provider/api/v1/loanproducts
Content-Type: application/json
Request Body:
new loan product json here
</code>
</div> </div>
</div> </div>
@@ -881,7 +1084,6 @@ new loan product json here
<div class="method-description"> <div class="method-description">
<h4>Update a Loan Product</h4> <h4>Update a Loan Product</h4>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://thedomainname/api/v1/loanproducts/{loanId}</code> <code class="method-declaration">POST https://thedomainname/api/v1/loanproducts/{loanId}</code>
<code class="method-request">http://localhost:8080/mifosng-provider/api/v1/loanproducts/1 <code class="method-request">http://localhost:8080/mifosng-provider/api/v1/loanproducts/1
@@ -891,29 +1093,9 @@ Content-Type: application/json
Request Body: Request Body:
update loan product json here update loan product json here
</code> </code>
</div> </div>
</div> </div>
<a id="additionalfields" name="additionalfields" class="old-syle-anchor">&nbsp;</a> <a id="additionalfields" name="additionalfields" class="old-syle-anchor">&nbsp;</a>
@@ -932,7 +1114,6 @@ The additional fields resource allows you to retrieve and update any Additional
<p> <p>
The Mifos X Individual Lending client application uses a JQuery plugin called stretchydata which, itself, uses this additional fields resource to provide a pretty flexible additional fields User Interface (UI). Put a link to an example here. The Mifos X Individual Lending client application uses a JQuery plugin called stretchydata which, itself, uses this additional fields resource to provide a pretty flexible additional fields User Interface (UI). Put a link to an example here.
</p> </p>
</div> </div>
</div> </div>
@@ -948,16 +1129,13 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
<h5>Arguments</h5> <h5>Arguments</h5>
<dl class="argument-list"> <dl class="argument-list">
<dt>type</dt> <dt>type</dt>
<dd>optional</span></dd> <dd><span>optional</span></dd>
<dd>The Additional Field Type (Mifos X database table) to restrict the output to</dd> <dd>The Additional Fields Type (Mifos X database table) to restrict the output to</dd>
</dl> </dl>
<p>Example Request: <p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/additionalfields?type=portfolio_client">http://localhost:8080/mifosng-provider/api/v1/additionalfields?type=portfolio_client</a> <a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/additionalfields?type=portfolio_client">http://localhost:8080/mifosng-provider/api/v1/additionalfields?type=portfolio_client</a>
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/additionalfields</code> <code class="method-declaration">GET https://thedomainname/api/v1/additionalfields</code>
<code class="method-response">{ <code class="method-response">{
@@ -986,13 +1164,10 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
<p> <p>
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). 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).
</p> </p>
<p>Example Request: <p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2">http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2</a> <a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2">http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2</a>
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/additionalfields/{type}/{set}/{id}</code> <code class="method-declaration">GET https://thedomainname/api/v1/additionalfields/{type}/{set}/{id}</code>
<code class="method-response">{ <code class="method-response">{
@@ -1112,9 +1287,6 @@ Returns the Set of Additional Fields data for the ID provided. The ID is the id
</code> </code>
</div> </div>
</div> </div>
<a id="additionalfields_update" name="additionalfields_update" class="old-syle-anchor">&nbsp;</a> <a id="additionalfields_update" name="additionalfields_update" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
@@ -1122,9 +1294,7 @@ Returns the Set of Additional Fields data for the ID provided. The ID is the id
<p> <p>
Updates (or creates) 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. Updates (or creates) 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.
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://thedomainname/api/v1/additionalfields/{type}/{set}/{id}</code> <code class="method-declaration">POST https://thedomainname/api/v1/additionalfields/{type}/{set}/{id}</code>
<code class="method-request">http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2 <code class="method-request">http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2
@@ -1148,7 +1318,6 @@ Request Body:
"entityId": 2 "entityId": 2
} }
</code> </code>
</div> </div>
</div> </div>
@@ -1173,8 +1342,6 @@ If Pentaho reports have been pre-defined, they can also be run through this reso
<p> <p>
The Mifos X Individual Lending client application uses a JQuery plugin called stretchyreporting which, itself, uses this reports resource to provide a pretty flexible reporting User Interface (UI). Put a link to an example here. The Mifos X Individual Lending client application uses a JQuery plugin called stretchyreporting which, itself, uses this reports resource to provide a pretty flexible reporting User Interface (UI). Put a link to an example here.
</p> </p>
</div> </div>
</div> </div>
@@ -1197,9 +1364,7 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
<p>Example Request: <p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/reports">http://localhost:8080/mifosng-provider/api/v1/reports</a> <a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/reports">http://localhost:8080/mifosng-provider/api/v1/reports</a>
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/reports</code> <code class="method-declaration">GET https://thedomainname/api/v1/reports</code>
<code class="method-response">{ <code class="method-response">{
@@ -1292,13 +1457,10 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
<dd>optional, <span>The only valid value is 'true'. If any other value is provided the argument will be ignored</span></dd> <dd>optional, <span>The only valid value is 'true'. If any other value is provided the argument will be ignored</span></dd>
<dd>Output will be delivered as a CSV file instead of JSON. Doesn't apply to Pentaho reports.</dd> <dd>Output will be delivered as a CSV file instead of JSON. Doesn't apply to Pentaho reports.</dd>
</dl> </dl>
<p>Example Request: <p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1">http://localhost:8080/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1</a> <a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1">http://localhost:8080/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1</a>
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/reports/{reportName}</code> <code class="method-declaration">GET https://thedomainname/api/v1/reports/{reportName}</code>
<code class="method-response">{ <code class="method-response">{
@@ -1356,9 +1518,8 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
</div> <!-- main-content-wrapper --> </div> <!-- main-content-wrapper -->
</div> </div>
</body>
</body></html> </html>