update api docs
This commit is contained in:
+21
-3
@@ -98,6 +98,7 @@ var jqxhr = $.ajax({
|
|||||||
<li><a href="#top">Mifos X API Documentation</a></li>
|
<li><a href="#top">Mifos X API Documentation</a></li>
|
||||||
<li><a href="#interact">Try The API From Your Browser</a></li>
|
<li><a href="#interact">Try The API From Your Browser</a></li>
|
||||||
<li><a href="#genopts">Generic Options</a></li>
|
<li><a href="#genopts">Generic Options</a></li>
|
||||||
|
<li><a href="#creates_and_updates">Creating and Updating</a></li>
|
||||||
<li><a href="#dates_and_numbers">Updating Dates and Numbers</a></li>
|
<li><a href="#dates_and_numbers">Updating Dates and Numbers</a></li>
|
||||||
<li><a href="#authentication_overview">Authentication Overview</a></li>
|
<li><a href="#authentication_overview">Authentication Overview</a></li>
|
||||||
<li><a href="#errors">Errors</a></li>
|
<li><a href="#errors">Errors</a></li>
|
||||||
@@ -270,6 +271,23 @@ var jqxhr = $.ajax({
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<a id="creates_and_updates" name="creates_and_updates" class="old-syle-anchor"> </a>
|
||||||
|
<div class="method-section">
|
||||||
|
<div class="method-description">
|
||||||
|
<h3>Creating and Updating</h3>
|
||||||
|
<p>
|
||||||
|
When you want to 'Create a...' you have to at least supply the mandatory fields.
|
||||||
|
You can see which fields are mandatory by clicking the 'Show Mandatory Fields' button under the relevant 'Create a ...' heading.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
When you want to 'Update a...' you can update individual fields or a combination of fields (subject to data integrity rules).
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
<a id="dates_and_numbers" name="dates_and_numbers" class="old-syle-anchor"> </a>
|
<a id="dates_and_numbers" name="dates_and_numbers" class="old-syle-anchor"> </a>
|
||||||
<div class="method-section">
|
<div class="method-section">
|
||||||
<div class="method-description">
|
<div class="method-description">
|
||||||
@@ -296,7 +314,7 @@ JSON examples:
|
|||||||
JSON examples:
|
JSON examples:
|
||||||
{
|
{
|
||||||
"locale": "en-us",
|
"locale": "en-us",
|
||||||
"principal": "240 400.88"
|
"principal": "240,400.88"
|
||||||
}
|
}
|
||||||
{
|
{
|
||||||
"locale": "fr-CH",
|
"locale": "fr-CH",
|
||||||
@@ -3342,7 +3360,7 @@ Request body:
|
|||||||
{
|
{
|
||||||
"name": "Another Role Name",
|
"name": "Another Role Name",
|
||||||
"description": "A description outlining the purpose of this role in relation to the application.",
|
"description": "A description outlining the purpose of this role in relation to the application.",
|
||||||
"permissions": ["1", "2", "3"]
|
"permissions": [1, 2, 3]
|
||||||
}
|
}
|
||||||
</code>
|
</code>
|
||||||
<code class="method-response">{
|
<code class="method-response">{
|
||||||
@@ -3364,7 +3382,7 @@ Content-Type: application/json
|
|||||||
Request body:
|
Request body:
|
||||||
{
|
{
|
||||||
"name": "Updated Role Name",
|
"name": "Updated Role Name",
|
||||||
"permissions": ["1"]
|
"permissions": [1]
|
||||||
}
|
}
|
||||||
</code>
|
</code>
|
||||||
<code class="method-response">{
|
<code class="method-response">{
|
||||||
|
|||||||
@@ -4,9 +4,7 @@ template for waiver/repayment... is it same for both? no type needed? (might hav
|
|||||||
new loan template ... is it 2 templates... one to pick product... and 2nd to return default properties in selected product or is it meant that if only one product then use that.
|
new loan template ... is it 2 templates... one to pick product... and 2nd to return default properties in selected product or is it meant that if only one product then use that.
|
||||||
|
|
||||||
|
|
||||||
|
--------------------------------------------------------
|
||||||
Configuration
|
|
||||||
All Good!
|
|
||||||
|
|
||||||
|
|
||||||
Users
|
Users
|
||||||
@@ -37,3 +35,13 @@ template - only get office 1 in allowed offices
|
|||||||
|
|
||||||
mandatoryfields - if pass {}
|
mandatoryfields - if pass {}
|
||||||
dates lose formatted - general docs, money... strings, locale, don't have to put in commas.....but do put in decs.
|
dates lose formatted - general docs, money... strings, locale, don't have to put in commas.....but do put in decs.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
--------------------------------------------------------
|
||||||
|
|
||||||
|
Permissions
|
||||||
|
groupType in or out?
|
||||||
|
|
||||||
|
Roles
|
||||||
|
"id" is a mandatory field (says something about updating in the msg)
|
||||||
|
|||||||
Reference in New Issue
Block a user