CBSNexora/cbsnexora-backend
4
0
Fork 0
Code Issues Pull Requests Actions 37 Packages Projects Releases Wiki Activity

update api docs after running through datatables api.2

Browse Source
This commit is contained in:
Keith Woodlock
2013-02-05 12:28:46 +00:00
parent 297263f5a0
commit 7ab3520738
3 changed files with 138 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-docs/apiLive.htm
+117 -93
View File
@@ -1628,23 +1628,25 @@ No Request Body:
<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>
<code class="method-response">{ <code class="method-response">{
"transactionType" : { "type": {
"id" : 2, "id": 2,
"code" : "loanTransactionType.repayment", "code": "loanTransactionType.repayment",
"value" : "Repayment" "value": "Repayment"
}, },
"date" : [ 2009, 8, 1 ], "date": [
"total" : { 2011,
"currencyCode" : "XOF", 10,
"digitsAfterDecimal" : 0, 20
"amount" : 471, ],
"defaultName" : "CFA Franc BCEAO", "currency": {
"nameCode" : "currency.XOF", "code": "USD",
"displaySymbol" : "CFA", "name": "US Dollar",
"zero" : false, "decimalPlaces": 2,
"greaterThanZero" : true, "displaySymbol": "$",
"displaySymbolValue" : "471 CFA" "nameCode": "currency.USD",
} "displayLabel": "US Dollar ($)"
},
"amount": 9455.96
} }
</code> </code>
</div> </div>
@@ -1662,19 +1664,27 @@ 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 loans/37/transactions?command=repayment <code class="method-request">POST loans/1/transactions?command=repayment
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
"locale": "en_GB", "locale": "en_GB",
"dateFormat": "dd MMMM yyyy", "dateFormat": "dd MMMM yyyy",
"transactionDate": "14 May 2012", "transactionDate": "20 October 2011",
"transactionAmount": "559.88", "transactionAmount": "9,455.96"
"note": "Repayment at branch"
} }
</code> </code>
<code class="method-response">{ <code class="method-response">{
"resourceId": 37 "officeId": 1,
"clientId": 1,
"loanId": 1,
"resourceId": 2,
"changes": {
"transactionDate": "20 October 2011",
"transactionAmount": "9,455.96",
"locale": "en_GB",
"dateFormat": "dd MMMM yyyy"
}
} }
</code> </code>
</div> </div>
@@ -1685,25 +1695,35 @@ 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>
<div class=apiClick>loans/10/transactions/20</div> <div class=apiClick>loans/1/transactions/1</div>
</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>
<code class="method-response">{ <code class="method-response">{
"id" : 10, "id": 1,
"date" : [ 2009, 1, 29 ], "type": {
"total" : { "id": 1,
"currencyCode" : "XOF", "code": "loanTransactionType.disbursement",
"digitsAfterDecimal" : 0, "value": "Dibursement"
"amount" : 300000,
"defaultName" : "CFA Franc BCEAO",
"nameCode" : "currency.XOF",
"displaySymbol" : "CFA",
"zero" : false,
"greaterThanZero" : true,
"displaySymbolValue" : "300000 CFA"
}, },
"transactionOffsetFromToday" : -1218 "date": [
2011,
9,
20
],
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 100000,
"principalPortion": 0,
"interestPortion": 0,
"feeChargesPortion": 0,
"penaltyChargesPortion": 0
} }
</code> </code>
</div> </div>
@@ -1720,19 +1740,27 @@ 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 loans/16/transactions/32 <code class="method-request">POST loans/1/transactions/1
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
"locale": "en_GB", "locale": "en_GB",
"dateFormat": "dd MMMM yyyy", "dateFormat": "dd MMMM yyyy",
"transactionDate": "25 May 2012", "transactionDate": "20 October 2011",
"transactionAmount": "50,000.00", "transactionAmount": "9,455.00"
"note": "adj note"
} }
</code> </code>
<code class="method-response">{ <code class="method-response">{
"resourceId": 16 "officeId": 1,
"clientId": 1,
"loanId": 1,
"resourceId": 2,
"changes": {
"transactionDate": "20 October 2011",
"transactionAmount": "9,455.00",
"locale": "en_GB",
"dateFormat": "dd MMMM yyyy"
}
} }
</code> </code>
</div> </div>
@@ -3032,15 +3060,11 @@ Content-Type: application/json
<code class="method-response">[ <code class="method-response">[
{ {
"applicationTableName": "m_client", "applicationTableName": "m_client",
"registeredTableName": "Additional Client Fields Data" "registeredTableName": "extra_client_details"
}, },
{ {
"applicationTableName": "m_client", "applicationTableName": "m_client",
"registeredTableName": "Extra Family Details Data" "registeredTableName": "extra_family_details"
},
{
"applicationTableName": "m_loan",
"registeredTableName": "Additional Loan Fields Data"
} }
] ]
</code> </code>
@@ -3057,14 +3081,16 @@ Content-Type: application/json
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/datatables/register/{datatable}/{apptable}</code> <code class="method-declaration">POST https://Domain Name/api/v1/datatables/register/{datatable}/{apptable}</code>
<code class="method-request">POST datatables/register/New Table/m_client <code class="method-request">POST datatables/register/extra_client_details/m_client
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
} }
</code> </code>
<code class="method-response">{ <code class="method-response">{
"resourceId": null "commandId": -1,
"officeId": -1,
"resourceId": -1
} }
</code> </code>
</div> </div>
@@ -3081,14 +3107,16 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/datatables/deregister/{datatable}</code> <code class="method-declaration">POST https://Domain Name/api/v1/datatables/deregister/{datatable}</code>
<code class="method-request">POST datatables/register/New Table <code class="method-request">POST datatables/deregister/extra_client_details
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
} }
</code> </code>
<code class="method-response">{ <code class="method-response">{
"resourceId": null "commandId": -1,
"officeId": -1,
"resourceId": -1
} }
</code> </code>
</div> </div>
@@ -3110,19 +3138,19 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://Domain Name/api/v1/datatables/{datatable}/{apptableId}</code> <code class="method-declaration">POST https://Domain Name/api/v1/datatables/{datatable}/{apptableId}</code>
<code class="method-request">POST datatables/Additional Client Fields Data/1 <code class="method-request">POST datatables/extra_client_details/1
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
"Business Description": "Livestock sales", "Business Description": "Livestock sales",
Comment: "First comment\nmade", "Comment": "First comment made",
Education_cv: "Trade", "Education_cv": "Primary",
Gender_cd: "21", "Gender_cd": "2",
"Highest Rate Paid": "8.5", "Highest Rate Paid": "8.5",
"Next Visit": "01 October 2012", "Next Visit": "01 October 2012",
"Years in Business": "5", "Years in Business": "5",
dateFormat: "dd MMMM yyyy", "dateFormat": "dd MMMM yyyy",
locale: "en" locale: "en"
} }
</code> </code>
<code class="method-response">{ <code class="method-response">{
@@ -3154,24 +3182,25 @@ Request Body:
</dl> </dl>
<p>Example Requests: </p> <p>Example Requests: </p>
<div class=apiClick>datatables/Additional Client Fields Data/1</div> <div class=apiClick>datatables/extra_client_details/1</div>
<br><br> <br><br>
<div class=apiClick>datatables/Extra Family Details Data/1?order=`Date of Birth` desc</div> <div class=apiClick>datatables/extra_family_details/1?order=`Date of Birth` desc</div>
<br><br> <br><br>
<div class=apiClick>datatables/Additional Client Fields Data/1?genericResultSet=true</div> <div class=apiClick>datatables/extra_client_details/1?genericResultSet=true</div>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://Domain Name/api/v1/datatables/{datatable}/{apptableId}</code> <code class="method-declaration">GET https://Domain Name/api/v1/datatables/{datatable}/{apptableId}</code>
<code class="method-response">[ <code class="method-response">[
{"client_id": 1, {
"Business Description": "Livestock sales", "client_id": 1,
"Years in Business": 5, "Business Description": "Livestock sales",
"Gender_cd": "21", "Years in Business": 5,
"Education_cv": "Trade", "Gender_cd": "2",
"Next Visit": [2012, 10, 1], "Education_cv": "Primary",
"Highest Rate Paid": 8.500000, "Next Visit": [2012, 10, 1],
"Comment": "First comment "Highest Rate Paid": 8.500000,
made"} "Comment": "First comment made"
}
] ]
</code> </code>
</div> </div>
@@ -3188,23 +3217,18 @@ made"}
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">PUT https://Domain Name/api/v1/datatables/{datatable}/{apptableId}</code> <code class="method-declaration">PUT https://Domain Name/api/v1/datatables/{datatable}/{apptableId}</code>
<code class="method-request">PUT datatables/Additional Client Fields Data/1 <code class="method-request">PUT datatables/extra_client_details/1
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
"Business Description": "Livestock sales updated", "Business Description": "Livestock sales (updated)"
Comment: "First comment\nmade",
Education_cv: "Trade",
Gender_cd: "21",
"Highest Rate Paid": "8.5",
"Next Visit": "01 October 2012",
"Years in Business": "5",
dateFormat: "dd MMMM yyyy",
locale: "en"
} }
</code> </code>
<code class="method-response">{ <code class="method-response">{
"resourceId": 1 "resourceId": 1,
"changes": {
"Business Description": "Livestock sales (updated)"
}
} }
</code> </code>
</div> </div>
@@ -3220,17 +3244,17 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">PUT https://Domain Name/api/v1/datatables/{datatable}/{apptableId}/{datatableId}</code> <code class="method-declaration">PUT https://Domain Name/api/v1/datatables/{datatable}/{apptableId}/{datatableId}</code>
<code class="method-request">PUT datatables/Extra Family Details Data/1/2 <code class="method-request">PUT datatables/extra_family_details/1/1
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
"Date of Birth": "01 June 1982", "Date of Birth": "01 June 1982",
Education_cdHighest: "5", "Education_cd_Highest": "5",
Name: "June", "Name": "June",
"Other Notes": "More\nnotes", "Other Notes": "More notes",
"Points Score": "20", "Points Score": "20",
dateFormat: "dd MMMM yyyy", "dateFormat": "dd MMMM yyyy",
locale: "en" "locale": "en"
} }
</code> </code>
<code class="method-response">{ <code class="method-response">{
@@ -3251,7 +3275,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">DELETE https://Domain Name/api/v1/datatables/{datatable}/{apptableId}</code> <code class="method-declaration">DELETE https://Domain Name/api/v1/datatables/{datatable}/{apptableId}</code>
<code class="method-request">DELETE datatables/Additional Client Fields Data/1 <code class="method-request">DELETE datatables/extra_client_details/1
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
@@ -3274,7 +3298,7 @@ Request Body:
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">DELETE https://Domain Name/api/v1/datatables/{datatable}/{apptableId}/{datatableId}</code> <code class="method-declaration">DELETE https://Domain Name/api/v1/datatables/{datatable}/{apptableId}/{datatableId}</code>
<code class="method-request">DELETE datatables/Extra Family Details Data/1/2 <code class="method-request">DELETE datatables/extra_family_details/1/2
Content-Type: application/json Content-Type: application/json
Request Body: Request Body:
{ {
mifosng-db/0002-mifosng-base-reference-data.sql
+3 -1
View File
@@ -15,7 +15,9 @@ VALUES
('maker-checker', 0); ('maker-checker', 0);
INSERT INTO `r_enum_value` INSERT INTO `r_enum_value`
VALUES ('amortization_method_enum',0,'Equal installments','Equal installments'),('amortization_method_enum',1,'Equal principle payments','Equal principle payments'), VALUES
('amortization_method_enum',0,'Equal principle payments','Equal principle payments'),
('amortization_method_enum',1,'Equal installments','Equal installments'),
('interest_calculated_in_period_enum',0,'Daily','Daily'),('interest_calculated_in_period_enum',1,'Same as repayment period','Same as repayment period'), ('interest_calculated_in_period_enum',0,'Daily','Daily'),('interest_calculated_in_period_enum',1,'Same as repayment period','Same as repayment period'),
('interest_method_enum',0,'Declining Balance','Declining Balance'),('interest_method_enum',1,'Flat','Flat'), ('interest_method_enum',0,'Declining Balance','Declining Balance'),('interest_method_enum',1,'Flat','Flat'),
('interest_period_frequency_enum',2,'Per month','Per month'),('interest_period_frequency_enum',3,'Per year','Per year'), ('interest_period_frequency_enum',2,'Per month','Per month'),('interest_period_frequency_enum',3,'Per year','Per year'),
mifosng-db/multi-tenant-demo-backups/default-demo/bk_mifostenant-default.sql
+18 -16
View File
File diff suppressed because one or more lines are too long