make apidocs easier to change WIP

This commit is contained in:
John Woodlock
2012-08-22 22:38:44 +10:00
parent 1aafc0b09d
commit ed82fdae52
2 changed files with 112 additions and 87 deletions
+6
View File
@@ -0,0 +1,6 @@
my api notes
- loan products api should return currencyCode and digitsAfterDecimal
2) "officeId": 1, comes back for clients/template ... seems to suggest a new client defaults to head office rather than select one?
+106 -87
View File
@@ -5,6 +5,26 @@
<link rel="stylesheet" href="apidocs.css" type="text/css" media="screen" title="Mifos X API Docs" charset="utf-8"/> <link rel="stylesheet" href="apidocs.css" type="text/css" media="screen" title="Mifos X API Docs" charset="utf-8"/>
<script type="text/javascript" src="jquery-1.7.min.js"></script> <script type="text/javascript" src="jquery-1.7.min.js"></script>
<title>Mifos X API Documentation</title> <title>Mifos X API Documentation</title>
<script>
baseURL = "https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/";
//baseURL = "https://localhost:8443/mifosng-provider/api/v1/";
defQueryParams = "tenantIdentifier=default&pretty=true";
function clickAPILink(apiLink)
{
var currentLink = baseURL + apiLink;
if (apiLink.indexOf("?") < 0) currentLink += "?" + defQueryParams;
else currentLink += "&" + defQueryParams;
//alert(currentLink);
location.href = currentLink;
}
</script>
</head> </head>
<body> <body>
@@ -167,7 +187,7 @@
The REST plugins will allow you to The REST plugins will allow you to
<ul> <ul>
<li class=normalli>Select the "Verb" (e.g. POST)</li> <li class=normalli>Select the "Verb" (e.g. POST)</li>
<li class=normalli>Enter the resource name (e.g. https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices)</li> <li class=normalli>Enter the resource name (e.g. offices)</li>
<li class=normalli>Add a header to indicate you are sending JSON data as part of the request body (Content-Type: application/json)</li> <li class=normalli>Add a header to indicate you are sending JSON data as part of the request body (Content-Type: application/json)</li>
<li class=normalli>Add a header to indicate your 'tenant' (X-Mifos-Platform-TenantId: default)</li> <li class=normalli>Add a header to indicate your 'tenant' (X-Mifos-Platform-TenantId: default)</li>
<li class=normalli>Paste the example JSON into a Request Body</li> <li class=normalli>Paste the example JSON into a Request Body</li>
@@ -195,8 +215,7 @@
<h4>Restrict Returned Fields</h4> <h4>Restrict Returned Fields</h4>
<p>Parameter "fields={fieldlist}" can be used on GET requests to restrict the fields returned.</p> <p>Parameter "fields={fieldlist}" can be used on GET requests to restrict the fields returned.</p>
<p>Example Request: </p> <p>Example Request: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true&fields=id,name,parentName"> <a href="unknown.html" onclick="clickAPILink('offices/1?fields=id,name,parentName');return false">offices/1?fields=id,name,parentName
https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true&fields=id,name,parentName
</a> </a>
<p></p> <p></p>
<h4>Pretty JSON Formatting</h4> <h4>Pretty JSON Formatting</h4>
@@ -304,7 +323,7 @@ JSON examples:
function setBasicAuthKey(username, password) { function setBasicAuthKey(username, password) {
var jqxhr = $.ajax({ var jqxhr = $.ajax({
url : "https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/authentication?username=" + username + "&password=" + password, url : "authentication?username=" + username + "&password=" + password,
type : 'POST', type : 'POST',
contentType : "application/json; charset=utf-8", contentType : "application/json; charset=utf-8",
dataType : 'json', dataType : 'json',
@@ -422,9 +441,9 @@ var jqxhr = $.ajax({
<div class="method-description"> <div class="method-description">
<h4>List Clients</h4> <h4>List Clients</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('clients');return false;">clients</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients?tenantIdentifier=default&pretty=true&fields=displayName,officeName,joinedDate">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients?tenantIdentifier=default&pretty=true&fields=displayName,officeName,joinedDate</a> <a href="unknown.html" onclick="clickAPILink('clients?fields=displayName,officeName,joinedDate');return false;">clients?fields=displayName,officeName,joinedDate</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/clients</code> <code class="method-declaration">GET https://Domain Name/api/v1/clients</code>
@@ -463,7 +482,7 @@ var jqxhr = $.ajax({
</ul> </ul>
</p> </p>
<p>Example Request: </p> <p>Example Request: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/template?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/template?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('clients/template');return false;">clients/template</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/clients/template</code> <code class="method-declaration">GET https://Domain Name/api/v1/clients/template</code>
@@ -496,11 +515,11 @@ var jqxhr = $.ajax({
<div class="method-description"> <div class="method-description">
<h4>Retrieve a Client</h4> <h4>Retrieve a Client</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('clients/1');return false;">clients/1</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?tenantIdentifier=default&pretty=true&template=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?tenantIdentifier=default&pretty=true&template=true</a> <a href="unknown.html" onclick="clickAPILink('clients/1?template=true');return false;">clients/1?template=true</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1?tenantIdentifier=default&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?tenantIdentifier=default&pretty=true&fields=id,displayName,officeName</a> <a href="unknown.html" onclick="clickAPILink('clients/1?fields=id,displayName,officeName');return false;">clients/1?fields=id,displayName,officeName</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/clients/{clientId}</code> <code class="method-declaration">GET https://Domain Name/api/v1/clients/{clientId}</code>
@@ -534,7 +553,7 @@ var jqxhr = $.ajax({
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/clients</code> <code class="method-declaration">POST https://Domain Name/api/v1/clients</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients <code class="method-request">POST clients
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -553,7 +572,7 @@ Request Body:
</code> </code>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients <code class="method-request">POST clients
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -579,7 +598,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">PUT https://Domain Name/api/v1/clients/{clientId}</code> <code class="method-declaration">PUT https://Domain Name/api/v1/clients/{clientId}</code>
<code class="method-request">PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/23 <code class="method-request">PUT clients/23
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -602,9 +621,9 @@ Request Body:
However, it is quite reasonable to add resources like this to simplify User Interface development. However, it is quite reasonable to add resources like this to simplify User Interface development.
</p> </p>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('clients/1/loans');return false;">clients/1/loans</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/loans?tenantIdentifier=default&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?tenantIdentifier=default&pretty=true&fields=openLoans,%20closedLoans,activeLoanCount</a> <a href="unknown.html" onclick="clickAPILink('clients/1/loans?fields=openLoans,%20closedLoans,activeLoanCount');return false;">clients/1/loans?fields=openLoans,%20closedLoans,activeLoanCount</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/clients/{clientId}/loans</code> <code class="method-declaration">GET https://Domain Name/api/v1/clients/{clientId}/loans</code>
@@ -656,9 +675,9 @@ Request Body:
<b>Note:</b> Notes are returned in descending createOn order. <b>Note:</b> Notes are returned in descending createOn order.
</p> </p>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('clients/2/notes');return false;">clients/2/notes</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes?tenantIdentifier=default&pretty=true&fields=note,createdOn,createdByUsername">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes?tenantIdentifier=default&pretty=true&fields=note,createdOn,createdByUsername</a> <a href="unknown.html" onclick="clickAPILink('clients/2/notes?fields=note,createdOn,createdByUsername');return false;">clients/2/notes?fields=note,createdOn,createdByUsername</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/clients/{clientId}/notes</code> <code class="method-declaration">GET https://Domain Name/api/v1/clients/{clientId}/notes</code>
@@ -708,7 +727,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/clients/{clientId}/notes</code> <code class="method-declaration">POST https://Domain Name/api/v1/clients/{clientId}/notes</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/1/notes <code class="method-request">POST clients/1/notes
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -727,9 +746,9 @@ Request Body:
<div class="method-description"> <div class="method-description">
<h4>Retrieve a Client Note</h4> <h4>Retrieve a Client Note</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('clients/2/notes/20');return false;">clients/2/notes/20</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20?tenantIdentifier=default&pretty=true&fields=note,createdOn,createdByUsername">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20?tenantIdentifier=default&pretty=true&fields=note,createdOn,createdByUsername</a> <a href="unknown.html" onclick="clickAPILink('clients/2/notes/20?fields=note,createdOn,createdByUsername');return false;">clients/2/notes/20?fields=note,createdOn,createdByUsername</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/clients/{clientId}/notes/{noteId}</code> <code class="method-declaration">GET https://Domain Name/api/v1/clients/{clientId}/notes/{noteId}</code>
@@ -762,7 +781,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">PUT https://Domain Name/api/v1/clients/{clientId}/notes/{noteId}</code> <code class="method-declaration">PUT https://Domain Name/api/v1/clients/{clientId}/notes/{noteId}</code>
<code class="method-request">PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/clients/2/notes/20 <code class="method-request">PUT clients/2/notes/20
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -851,9 +870,9 @@ Request Body:
<dd>If entered, productId, productName and selectedProduct fields are returned. </dd> <dd>If entered, productId, productName and selectedProduct fields are returned. </dd>
</dl> </dl>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="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://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/template?clientId=1&productId=1&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('loans/template?clientId=1&productId=1');return false;">loans/template?clientId=1&productId=1</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com: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</a> <a href="unknown.html" onclick="clickAPILink('loans/template?clientId=1');return false;">loans/template?clientId=1</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/loans/template</code> <code class="method-declaration">GET https://Domain Name/api/v1/loans/template</code>
@@ -1061,13 +1080,13 @@ Request Body:
<dd><b>'convenienceData':</b> Some derived data that is specific to the needs of the current Individual Lending client application.</dd> <dd><b>'convenienceData':</b> Some derived data that is specific to the needs of the current Individual Lending client application.</dd>
</dl> </dl>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('loans/1');return false;">loans/1</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true&fields=id,principal,annualInterestRate">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true&fields=id,principal,annualInterestRate</a> <a href="unknown.html" onclick="clickAPILink('loans/1?fields=id,principal,annualInterestRate');return false;">loans/1?fields=id,principal,annualInterestRate</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true&associations=all">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true&associations=all</a> <a href="unknown.html" onclick="clickAPILink('loans/1?associations=all');return false;">loans/1?associations=all</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true&fields=id,principal,annualInterestRate&associations=summary,repaymentSchedule">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?tenantIdentifier=default&pretty=true&fields=id,principal,annualInterestRate&associations=summary,repaymentSchedule</a> <a href="unknown.html" onclick="clickAPILink('loans/1?fields=id,principal,annualInterestRate&associations=summary,repaymentSchedule');return false;">loans/1?fields=id,principal,annualInterestRate&associations=summary,repaymentSchedule</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/loans/{loanId}</code> <code class="method-declaration">GET https://Domain Name/api/v1/loans/{loanId}</code>
@@ -1164,7 +1183,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/loans</code> <code class="method-declaration">POST https://Domain Name/api/v1/loans</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans <code class="method-request">POST loans
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -1216,7 +1235,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/loans/{loanId}</code> <code class="method-declaration">POST https://Domain Name/api/v1/loans/{loanId}</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1?command=approve <code class="method-request">POST loans/1?command=approve
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -1240,7 +1259,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">DELETE https://Domain Name/api/v1/loans/{loanId}</code> <code class="method-declaration">DELETE https://Domain Name/api/v1/loans/{loanId}</code>
<code class="method-request">DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/1 <code class="method-request">DELETE loans/1
Content-Type: application/json Content-Type: application/json
No Request Body: No Request Body:
</code> </code>
@@ -1274,7 +1293,7 @@ No Request Body:
The amount that can be waived is limited to the loan's inArrearsTolerance</dd> The amount that can be waived is limited to the loan's inArrearsTolerance</dd>
</dl> </dl>
<p>Example Request: </p> <p>Example Request: </p>
<a style="word-wrap: break-word;" href="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">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</a> <a href="unknown.html" onclick="clickAPILink('loans/10/transactions/template?command=repayment');return false;">loans/10/transactions/template?command=repayment</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/loans/{loanId}/transactions/template"</code> <code class="method-declaration">GET https://Domain Name/api/v1/loans/{loanId}/transactions/template"</code>
@@ -1313,7 +1332,7 @@ No Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/loans/{loanId}/transactions</code> <code class="method-declaration">POST https://Domain Name/api/v1/loans/{loanId}/transactions</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/37/transactions?command=repayment <code class="method-request">POST loans/37/transactions?command=repayment
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -1336,7 +1355,7 @@ Request Body:
<div class="method-description"> <div class="method-description">
<h4>Retrieve a Repayment or Waiver Details</h4> <h4>Retrieve a Repayment or Waiver Details</h4>
<p>Example Request: </p> <p>Example Request: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/10/transactions/20?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/10/transactions/20?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('loans/10/transactions/20');return false;">loans/10/transactions/20</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/loans/{loanId}/transactions/{transactionId}</code> <code class="method-declaration">GET https://Domain Name/api/v1/loans/{loanId}/transactions/{transactionId}</code>
@@ -1375,7 +1394,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/loans/{loanId}/transactions/{transactionId}</code> <code class="method-declaration">POST https://Domain Name/api/v1/loans/{loanId}/transactions/{transactionId}</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loans/16/transactions/32 <code class="method-request">POST loans/16/transactions/32
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -1424,9 +1443,9 @@ Request Body:
<div class="method-description"> <div class="method-description">
<h4>List Offices</h4> <h4>List Offices</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('offices');return false;">offices</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices?fields=id,name,openingDate&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices?fields=id,name,openingDate&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('offices?fields=id,name,openingDate');return false;">offices?fields=id,name,openingDate</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/offices</code> <code class="method-declaration">GET https://Domain Name/api/v1/offices</code>
@@ -1470,8 +1489,8 @@ Request Body:
</ul> </ul>
</p> </p>
<p>Example Request: </p> <p>Example Request: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/template?tenantIdentifier=default&pretty=true"> <a href="unknown.html" onclick="clickAPILink('offices/template');return false;">
https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/template?tenantIdentifier=default&pretty=true offices/template
</a> </a>
</div> </div>
<div class="method-example"> <div class="method-example">
@@ -1498,16 +1517,16 @@ Request Body:
<div class="method-description"> <div class="method-description">
<h4>Retrieve an Office</h4> <h4>Retrieve an Office</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true"> <a href="unknown.html" onclick="clickAPILink('offices/1');return false;">
https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true offices/1
</a> </a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true&template=true"> <a href="unknown.html" onclick="clickAPILink('offices/1?template=true');return false;">
https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true&template=true offices/1?template=true
</a> </a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true&fields=id,name,parentName"> <a href="unknown.html" onclick="clickAPILink('offices/1?fields=id,name,parentName');return false;">
https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1?tenantIdentifier=default&pretty=true&fields=id,name,parentName offices/1?fields=id,name,parentName
</a> </a>
</div> </div>
<div class="method-example"> <div class="method-example">
@@ -1536,7 +1555,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/offices</code> <code class="method-declaration">POST https://Domain Name/api/v1/offices</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices <code class="method-request">POST offices
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -1561,7 +1580,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">PUT https://Domain Name/api/v1/offices/{officeId}</code> <code class="method-declaration">PUT https://Domain Name/api/v1/offices/{officeId}</code>
<code class="method-request">PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/offices/1 <code class="method-request">PUT offices/1
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -1638,9 +1657,9 @@ Request Body:
<div class="method-description"> <div class="method-description">
<h4>List Loan Products</h4> <h4>List Loan Products</h4>
<p>Example Requests:</p> <p>Example Requests:</p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('loanproducts');return false;">loanproducts</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts?tenantIdentifier=default&pretty=true&fields=name,description,interestRateFrequencyType,amortizationType">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts?tenantIdentifier=default&pretty=true&fields=name,description,interestRateFrequencyType,amortizationType</a> <a href="unknown.html" onclick="clickAPILink('loanproducts?fields=name,description,interestRateFrequencyType,amortizationType');return false;">loanproducts?fields=name,description,interestRateFrequencyType,amortizationType</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/loanproducts</code> <code class="method-declaration">GET https://Domain Name/api/v1/loanproducts</code>
@@ -1774,7 +1793,7 @@ Request Body:
</ul> </ul>
</p> </p>
<p>Example Request: </p> <p>Example Request: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/template?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/template?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('loanproducts/template');return false;">loanproducts/template</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/loanproducts/template</code> <code class="method-declaration">GET https://Domain Name/api/v1/loanproducts/template</code>
@@ -1930,11 +1949,11 @@ Request Body:
<div class="method-description"> <div class="method-description">
<h4>Retrieve a Loan Product</h4> <h4>Retrieve a Loan Product</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('loanproducts/1');return false;">loanproducts/1</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?tenantIdentifier=default&pretty=true&template=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?tenantIdentifier=default&pretty=true&template=true</a> <a href="unknown.html" onclick="clickAPILink('loanproducts/1?template=true');return false;">loanproducts/1?template=true</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?tenantIdentifier=default&pretty=true&fields=name,description,numberOfRepayments">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1?tenantIdentifier=default&pretty=true&fields=name,description,numberOfRepayments</a> <a href="unknown.html" onclick="clickAPILink('loanproducts/1?fields=name,description,numberOfRepayments');return false;">loanproducts/1?fields=name,description,numberOfRepayments</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/loanproducts/{productId}</code> <code class="method-declaration">GET https://Domain Name/api/v1/loanproducts/{productId}</code>
@@ -2013,7 +2032,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/loanproducts</code> <code class="method-declaration">POST https://Domain Name/api/v1/loanproducts</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts <code class="method-request">POST loanproducts
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -2048,7 +2067,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/loanproducts/{loanId}</code> <code class="method-declaration">POST https://Domain Name/api/v1/loanproducts/{loanId}</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/loanproducts/1 <code class="method-request">POST loanproducts/1
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -2080,9 +2099,9 @@ Request Body:
<h4>Retrieve Currency Configuration</h4> <h4>Retrieve Currency Configuration</h4>
<p>Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection).</p> <p>Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection).</p>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('configurations/currency');return false;">configurations/currency</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?tenantIdentifier=default&pretty=true&fields=selectedCurrencyOptions">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency?tenantIdentifier=default&pretty=true&fields=selectedCurrencyOptions</a> <a href="unknown.html" onclick="clickAPILink('configurations/currency?fields=selectedCurrencyOptions');return false;">configurations/currency?fields=selectedCurrencyOptions</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/configurations/currency</code> <code class="method-declaration">GET https://Domain Name/api/v1/configurations/currency</code>
@@ -2131,7 +2150,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">PUT https://Domain Name/api/v1/configurations/currency</code> <code class="method-declaration">PUT https://Domain Name/api/v1/configurations/currency</code>
<code class="method-request">PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/configurations/currency <code class="method-request">PUT configurations/currency
Content-Type: application/json Content-Type: application/json
Request Body:{ Request Body:{
"currencies": ["KES", "BND", "LBP", "GHC", "USD", "XOF", "AED", "AMD"] "currencies": ["KES", "BND", "LBP", "GHC", "USD", "XOF", "AED", "AMD"]
@@ -2192,9 +2211,9 @@ Request Body:{
<dd>The Additional Fields 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 Requests: </p> <p>Example Requests: </p>
<a href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com: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</a> <a href="unknown.html" onclick="clickAPILink('additionalfields?type=m_client');return false;">additionalfields?type=m_client</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('additionalfields');return false;">additionalfields</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/additionalfields</code> <code class="method-declaration">GET https://Domain Name/api/v1/additionalfields</code>
@@ -2224,7 +2243,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). 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="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2?tenantIdentifier=default&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?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('additionalfields/m_client/Additional Information/2');return false;">additionalfields/m_client/Additional Information/2</a>
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
@@ -2302,7 +2321,7 @@ Request Body:{
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/additionalfields/{type}/{set}/{id}</code> <code class="method-declaration">POST https://Domain Name/api/v1/additionalfields/{type}/{set}/{id}</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2 <code class="method-request">POST additionalfields/portfolio_client/Additional Information/2
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -2361,9 +2380,9 @@ Request Body:
<dd>Output will be delivered as a CSV file instead of JSON.</dd> <dd>Output will be delivered as a CSV file instead of JSON.</dd>
</dl> </dl>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('reports');return false;">reports</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?tenantIdentifier=default&pretty=true&exportCSV=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports?tenantIdentifier=default&pretty=true&exportCSV=true</a> <a href="unknown.html" onclick="clickAPILink('reports?exportCSV=true');return false;">reports?exportCSV=true</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/reports</code> <code class="method-declaration">GET https://Domain Name/api/v1/reports</code>
@@ -2483,13 +2502,13 @@ Request Body:
<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 Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('reports/Client%20Listing?R_officeId=1');return false;">reports/Client%20Listing?R_officeId=1</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1&pretty=true&exportCSV=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/reports/Client%20Listing?R_officeId=1&pretty=true&exportCSV=true</a> <a href="unknown.html" onclick="clickAPILink('reports/Client%20Listing?R_officeId=1&exportCSV=true');return false;">reports/Client%20Listing?R_officeId=1&exportCSV=true</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="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">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</a> <a href="unknown.html" onclick="clickAPILink('reports/selectOfficeId?R_officeId=1&pretty=true&parameterType=true');return false;">reports/selectOfficeId?R_officeId=1& parameterType=true</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="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">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</a> <a href="unknown.html" onclick="clickAPILink('reports/selectOfficeId?R_officeId=1&pretty=true&parameterType=true&exportCSV=true');return false;">reports/selectOfficeId?R_officeId=1& parameterType=true&exportCSV=true</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/reports/{reportName}</code> <code class="method-declaration">GET https://Domain Name/api/v1/reports/{reportName}</code>
@@ -2591,7 +2610,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/authentication?username={username}&password={password}</code> <code class="method-declaration">POST https://Domain Name/api/v1/authentication?username={username}&password={password}</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/authentication?username=super1&password=demo <code class="method-request">POST authentication?username=super1&password=demo
Content-Type: application/json Content-Type: application/json
No Request Body No Request Body
</code> </code>
@@ -2625,9 +2644,9 @@ No Request Body
<div class="method-description"> <div class="method-description">
<h4>Retrieve list of users</h4> <h4>Retrieve list of users</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('users');return false;">users</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users?tenantIdentifier=default&pretty=true&fields=id,username,email,officeName">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users?tenantIdentifier=default&pretty=true&fields=id,username,email,officeName</a> <a href="unknown.html" onclick="clickAPILink('users?fields=id,username,email,officeName');return false;">users?fields=id,username,email,officeName</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/users</code> <code class="method-declaration">GET https://Domain Name/api/v1/users</code>
@@ -2663,7 +2682,7 @@ No Request Body
</ul> </ul>
</p> </p>
<p>Example Request: </p> <p>Example Request: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/template?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/template?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('users/template');return false;">users/template</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/users/template</code> <code class="method-declaration">GET https://Domain Name/api/v1/users/template</code>
@@ -2725,11 +2744,11 @@ No Request Body
<div class="method-description"> <div class="method-description">
<h4>Retrieve a User</h4> <h4>Retrieve a User</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('users/1');return false;">users/1</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?tenantIdentifier=default&pretty=true&template=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?tenantIdentifier=default&pretty=true&template=true</a> <a href="unknown.html" onclick="clickAPILink('users/1?template=true');return false;">users/1?template=true</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?tenantIdentifier=default&pretty=true&fields=username,officeName">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/1?tenantIdentifier=default&pretty=true&fields=username,officeName</a> <a href="unknown.html" onclick="clickAPILink('users/1?fields=username,officeName');return false;">users/1?fields=username,officeName</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/users/1</code> <code class="method-declaration">GET https://Domain Name/api/v1/users/1</code>
@@ -2789,7 +2808,7 @@ No Request Body
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/users</code> <code class="method-declaration">POST https://Domain Name/api/v1/users</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users <code class="method-request">POST users
Content-Type: application/json Content-Type: application/json
Request body: Request body:
{ {
@@ -2817,7 +2836,7 @@ Request body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">PUT https://Domain Name/api/v1/users/{userId)</code> <code class="method-declaration">PUT https://Domain Name/api/v1/users/{userId)</code>
<code class="method-request">PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/3 <code class="method-request">PUT users/3
Content-Type: application/json Content-Type: application/json
Request body: Request body:
{ {
@@ -2844,7 +2863,7 @@ Request body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">DELETE https://Domain Name/api/v1/users/{userId}</code> <code class="method-declaration">DELETE https://Domain Name/api/v1/users/{userId}</code>
<code class="method-request">DELETE https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/users/20 <code class="method-request">DELETE users/20
Content-Type: application/json Content-Type: application/json
No Request Body No Request Body
</code> </code>
@@ -2871,9 +2890,9 @@ No Request Body
<div class="method-description"> <div class="method-description">
<h4>List Roles</h4> <h4>List Roles</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('roles');return false;">roles</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles?tenantIdentifier=default&pretty=true&fields=name">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles?tenantIdentifier=default&pretty=true&fields=name</a> <a href="unknown.html" onclick="clickAPILink('roles?fields=name');return false;">roles?fields=name</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/roles</code> <code class="method-declaration">GET https://Domain Name/api/v1/roles</code>
@@ -2913,7 +2932,7 @@ No Request Body
</ul> </ul>
</p> </p>
<p>Example Request: </p> <p>Example Request: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/template?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/template?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('roles/template');return false;">roles/template</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/roles/template</code> <code class="method-declaration">GET https://Domain Name/api/v1/roles/template</code>
@@ -2949,11 +2968,11 @@ No Request Body
<div class="method-description"> <div class="method-description">
<h4>Retrieve a Role</h4> <h4>Retrieve a Role</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('roles/1');return false;">roles/1</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?tenantIdentifier=default&pretty=true&template=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?tenantIdentifier=default&pretty=true&template=true</a> <a href="unknown.html" onclick="clickAPILink('roles/1?template=true');return false;">roles/1?template=true</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?tenantIdentifier=default&pretty=true&fields=name,selectedPermissions">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/1?tenantIdentifier=default&pretty=true&fields=name,selectedPermissions</a> <a href="unknown.html" onclick="clickAPILink('roles/1?fields=name,selectedPermissions');return false;">roles/1?fields=name,selectedPermissions</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/roles/{roleId}</code> <code class="method-declaration">GET https://Domain Name/api/v1/roles/{roleId}</code>
@@ -2998,7 +3017,7 @@ No Request Body
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/roles</code> <code class="method-declaration">POST https://Domain Name/api/v1/roles</code>
<code class="method-request">POST https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles <code class="method-request">POST roles
Content-Type: application/json Content-Type: application/json
Request body: Request body:
{ {
@@ -3021,7 +3040,7 @@ Request body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">PUT https://Domain Name/api/v1/roles/{roleId}</code> <code class="method-declaration">PUT https://Domain Name/api/v1/roles/{roleId}</code>
<code class="method-request">PUT https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/roles/8 <code class="method-request">PUT roles/8
Content-Type: application/json Content-Type: application/json
Request body: Request body:
{ {
@@ -3051,9 +3070,9 @@ Request body:
<div class="method-description"> <div class="method-description">
<h4>List Application Permissions</h4> <h4>List Application Permissions</h4>
<p>Example Requests: </p> <p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/permissions?tenantIdentifier=default&pretty=true">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/permissions?tenantIdentifier=default&pretty=true</a> <a href="unknown.html" onclick="clickAPILink('permissions');return false;">permissions</a>
<br><br> <br><br>
<a style="word-wrap: break-word;" href="https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/permissions?tenantIdentifier=default&pretty=true&fields=id,code">https://ec2-46-137-62-163.eu-west-1.compute.amazonaws.com:8443/mifosng-provider/api/v1/permissions?tenantIdentifier=default&pretty=true&fields=id,code</a> <a href="unknown.html" onclick="clickAPILink('permissions?fields=id,code');return false;">permissions?fields=id,code</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/permissions</code> <code class="method-declaration">GET https://Domain Name/api/v1/permissions</code>