WIP api docs - matrix
This commit is contained in:
John Woodlock
+147
-37
@@ -12,70 +12,180 @@
|
||||
<div id="flybar">
|
||||
<div class="flybar-nav">
|
||||
<h2 class="flybar-button">Overview</h2>
|
||||
<div class="flybar-menu">go on then
|
||||
<div class="flybar-menu-overview">
|
||||
<div class="toc-column1">
|
||||
<div class="toc-section">
|
||||
<ul>
|
||||
<li><a href="#top">Mifos X API Documentation</a></li>
|
||||
<li><a href="#authentication_overview">Authentication Overview</a></li>
|
||||
<li><a href="#errors">Errors</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="flybar-nav">
|
||||
<h2 class="flybar-button">Core</h2>
|
||||
<div class="flybar-menu">
|
||||
<div class="tocMatrix">
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG"><td></td><td valign="top"><div class="matrixHeadingVerbs"><table><tr><td>Resources</td></tr></table></div></td><td><table><tr><td><div class="matrixHeadingVerbs">POST</div></td></tr><tr><td>create/update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">GET</div></td></tr><tr><td>read</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">PUT</div></td></tr><tr><td>simple update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">DELETE</div></td></tr><tr><td>delete</td></tr></table></td></tr>
|
||||
<tr><td><a href="#clients">CLIENT</a></td><td>/v1/clients</td><td><a href="api.htm#clients_create">Create a Client</a></td><td><a href="#clients_list">List Clients</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}</td><td align="center">-</td><td><a href="#clients_retrieve">Retrieve a Client</a></td><td><a href="#clients_update">Update a Client</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/loans</td><td align="center">-</td><td><a href="#clients_loansummary">Retrieve a Client's Loan Account Summary</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}/notes</td><td><a href="#clients_addnote">Add a Client Note</a></td><td><a href="#clients_notes">Retrieve a Client's Notes</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/notes/{noteId}</td><td align="center">-</td><td><a href="#clients_retrievenote">Retrieve a Client Note</a></td><td><a href="#clients_updatenote">Update a Client Note</a></td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#loans">LOAN</a></td><td>/v1/loans</td><td><a href="#loans_create">Create a New Loan/Submit a Loan Application</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}</td><td><a href="#loans_approve_etc">Approve, Disburse, Reject a Loan or Withdraw a Loan Application</a></td><td><a href="#loans_retrieve">Retrieve a Loan</a></td><td align="center">-</td><td><a href="#loans_delete">Delete a Loan</a></td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/undo</td><td><a href="#loans_undoapproval_etc">Undo Loan Approval or Disbursal</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}/transactions</td><td><a href="#loans_repayment_etc">Make a Repayment / Loan Waiver</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/transactions/{transactionId}</td><td align="center">-</td><td><a href="#loans_repaymentretrieve_etc">Retrieve a Repayment or Waiver Details</a></td><td><a href="#loans_repaymentadjust_etc">Adjust a Repayment or Waiver</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#offices">OFFICE</a></td><td>/v1/offices</td><td><a href="#offices_create">Create an Office</a></td><td><a href="#offices_list">List Offices</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/offices/{officeId}</td><td align="center">-</td><td><a href="#offices_retrieve">Retrieve an Office</a></td><td><a href="#offices_update">Update an Office</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#loanproducts">LOAN PRODUCT</a></td><td>/v1/loanproducts</td><td><a href="#loanproducts_create">Create a Loan Product</a></td><td><a href="#loanproducts_list">List Loan Products</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loanproducts/{productId}</td><td align="center">-</td><td><a href="#loanproducts_retrieve">Retrieve a Loan Product</a></td><td><a href="#loanproducts_update">Update a Loan Product</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#configs">CONFIGURATION</a></td><td>/v1/configurations/currency</td><td align="center">-</td><td><a href="#configs_currencyretrieve">Retrieve Currency Configuration Settings</a></td><td><a href="#configs_currencyupdate">Update Currency Configuration Settings</a></td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#additionalfields">ADDITIONAL FIELDS</a></td><td>/v1/additionalfields</td><td align="center">-</td><td><a href="#additionalfields_list">List Additional Fields Sets</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/additionalfields/{Type}/{Set}/{id}</td><td><a href="#additionalfields_update">Update Additional Fields</a></td><td><a href="#additionalfields_retrieve">Retrieve Additional Fields</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#reports">REPORT</a></td><td>/v1/reports</td><td align="center">-</td><td><a href="#reports_list">List Reports</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/reports/{reportName}</td><td align="center">-</td><td><a href="#report_run">Run a Report</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#authentication">AUTHENTICATION</a></td><td>/v1/authentication</td><td><a href="#authentication_permissions">Verify Authentication</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#useraccounts">USER ACCOUNT</a></td><td>/v1/useraccounts/current</td><td align="center">-</td><td><a href="#useraccount_details_retrieve">Retrieve Current Users' Account Details</a></td><td><a href="#useraccount_details_update">Update Current Users' Account Details</a></td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/useraccounts/current/password</td><td align="center">-</td><td align="center">-</td><td><a href="#useraccount_password_update">Update Current Users' Password</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#users">USER</a></td><td>/v1/users</td><td><a href="#users_create">Create a User</a></td><td><a href="#users_list">List Users</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/users/{userId}</td><td align="center">-</td><td><a href="#users_retrieve">Retrieve a User</a></td><td><a href="#users_update">Update a User</a></td><td><a href="#users_delete">Delete a User</a></td></tr>
|
||||
<tr class="alt"><td><a href="#roles">ROLE</a></td><td>/v1/roles</td><td><a href="#roles_create">Create a New Role</a></td><td><a href="#roles_list">List Roles</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/roles/{roleId}</td><td align="center">-</td><td><a href="#roles_retrieve">Retrieve a Role</a></td><td><a href="#roles_update">Update a Role</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#permissions">PERMISSION</a></td><td>/v1/permissions</td><td align="center">-</td><td><a href="#permissions_list">List Application Permissions</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
</table>
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG"><td></td><td valign="top"><div class="matrixHeadingVerbs"><table><tr><td>Resources</td></tr></table></div></td><td><table><tr><td><div class="matrixHeadingVerbs">POST</div></td></tr><tr><td>create/update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">GET</div></td></tr><tr><td>read</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">PUT</div></td></tr><tr><td>simple update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">DELETE</div></td></tr><tr><td>delete</td></tr></table></td></tr>
|
||||
<tr class="alt"><td><a href="#clients">CLIENT</a></td><td>/v1/clients</td><td><a href="api.htm#clients_create">Create a Client</a></td><td><a href="#clients_list">List Clients</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}</td><td align="center">-</td><td><a href="#clients_retrieve">Retrieve a Client</a></td><td><a href="#clients_update">Update a Client</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/loans</td><td align="center">-</td><td><a href="#clients_loansummary">Retrieve a Client's Loan Account Summary</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}/notes</td><td><a href="#clients_addnote">Add a Client Note</a></td><td><a href="#clients_notes">Retrieve a Client's Notes</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/notes/{noteId}</td><td align="center">-</td><td><a href="#clients_retrievenote">Retrieve a Client Note</a></td><td><a href="#clients_updatenote">Update a Client Note</a></td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#loans">LOAN</a></td><td>/v1/loans</td><td><a href="#loans_create">Create a New Loan/Submit a Loan Application</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}</td><td><a href="#loans_approve_etc">Approve, Disburse, Reject a Loan or Withdraw a Loan Application</a></td><td><a href="#loans_retrieve">Retrieve a Loan</a></td><td align="center">-</td><td><a href="#loans_delete">Delete a Loan</a></td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/undo</td><td><a href="#loans_undoapproval_etc">Undo Loan Approval or Disbursal</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}/transactions</td><td><a href="#loans_repayment_etc">Make a Repayment / Loan Waiver</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/transactions/{transactionId}</td><td align="center">-</td><td><a href="#loans_repaymentretrieve_etc">Retrieve a Repayment or Waiver Details</a></td><td><a href="#loans_repaymentadjust_etc">Adjust a Repayment or Waiver</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#offices">OFFICE</a></td><td>/v1/offices</td><td><a href="#offices_create">Create an Office</a></td><td><a href="#offices_list">List Offices</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/offices/{officeId}</td><td align="center">-</td><td><a href="#offices_retrieve">Retrieve an Office</a></td><td><a href="#offices_update">Update an Office</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#loanproducts">LOAN PRODUCT</a></td><td>/v1/loanproducts</td><td><a href="#loanproducts_create">Create a Loan Product</a></td><td><a href="#loanproducts_list">List Loan Products</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loanproducts/{productId}</td><td align="center">-</td><td><a href="#loanproducts_retrieve">Retrieve a Loan Product</a></td><td><a href="#loanproducts_update">Update a Loan Product</a></td><td align="center">-</td></tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="flybar-nav">
|
||||
<h2 class="flybar-button">Configuration</h2>
|
||||
<div class="flybar-menu">go on then
|
||||
<div class="flybar-menu">
|
||||
<div class="tocMatrix">
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG"><td></td><td valign="top"><div class="matrixHeadingVerbs"><table><tr><td>Resources</td></tr></table></div></td><td><table><tr><td><div class="matrixHeadingVerbs">POST</div></td></tr><tr><td>create/update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">GET</div></td></tr><tr><td>read</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">PUT</div></td></tr><tr><td>simple update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">DELETE</div></td></tr><tr><td>delete</td></tr></table></td></tr>
|
||||
<tr class="alt"><td><a href="#configs">CONFIGURATION</a></td><td>/v1/configurations/currency</td><td align="center">-</td><td><a href="#configs_currencyretrieve">Retrieve Currency Configuration Settings</a></td><td><a href="#configs_currencyupdate">Update Currency Configuration Settings</a></td><td align="center">-</td></tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="flybar-nav">
|
||||
<h2 class="flybar-button">Additional Fields</h2>
|
||||
<div class="flybar-menu">go on then
|
||||
<div class="flybar-menu">
|
||||
<div class="tocMatrix">
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG"><td></td><td valign="top"><div class="matrixHeadingVerbs"><table><tr><td>Resources</td></tr></table></div></td><td><table><tr><td><div class="matrixHeadingVerbs">POST</div></td></tr><tr><td>create/update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">GET</div></td></tr><tr><td>read</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">PUT</div></td></tr><tr><td>simple update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">DELETE</div></td></tr><tr><td>delete</td></tr></table></td></tr>
|
||||
<tr><td><a href="#clients">CLIENT</a></td><td>/v1/clients</td><td><a href="api.htm#clients_create">Create a Client</a></td><td><a href="#clients_list">List Clients</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}</td><td align="center">-</td><td><a href="#clients_retrieve">Retrieve a Client</a></td><td><a href="#clients_update">Update a Client</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/loans</td><td align="center">-</td><td><a href="#clients_loansummary">Retrieve a Client's Loan Account Summary</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}/notes</td><td><a href="#clients_addnote">Add a Client Note</a></td><td><a href="#clients_notes">Retrieve a Client's Notes</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/notes/{noteId}</td><td align="center">-</td><td><a href="#clients_retrievenote">Retrieve a Client Note</a></td><td><a href="#clients_updatenote">Update a Client Note</a></td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#loans">LOAN</a></td><td>/v1/loans</td><td><a href="#loans_create">Create a New Loan/Submit a Loan Application</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}</td><td><a href="#loans_approve_etc">Approve, Disburse, Reject a Loan or Withdraw a Loan Application</a></td><td><a href="#loans_retrieve">Retrieve a Loan</a></td><td align="center">-</td><td><a href="#loans_delete">Delete a Loan</a></td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/undo</td><td><a href="#loans_undoapproval_etc">Undo Loan Approval or Disbursal</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}/transactions</td><td><a href="#loans_repayment_etc">Make a Repayment / Loan Waiver</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/transactions/{transactionId}</td><td align="center">-</td><td><a href="#loans_repaymentretrieve_etc">Retrieve a Repayment or Waiver Details</a></td><td><a href="#loans_repaymentadjust_etc">Adjust a Repayment or Waiver</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#offices">OFFICE</a></td><td>/v1/offices</td><td><a href="#offices_create">Create an Office</a></td><td><a href="#offices_list">List Offices</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/offices/{officeId}</td><td align="center">-</td><td><a href="#offices_retrieve">Retrieve an Office</a></td><td><a href="#offices_update">Update an Office</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#loanproducts">LOAN PRODUCT</a></td><td>/v1/loanproducts</td><td><a href="#loanproducts_create">Create a Loan Product</a></td><td><a href="#loanproducts_list">List Loan Products</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loanproducts/{productId}</td><td align="center">-</td><td><a href="#loanproducts_retrieve">Retrieve a Loan Product</a></td><td><a href="#loanproducts_update">Update a Loan Product</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#configs">CONFIGURATION</a></td><td>/v1/configurations/currency</td><td align="center">-</td><td><a href="#configs_currencyretrieve">Retrieve Currency Configuration Settings</a></td><td><a href="#configs_currencyupdate">Update Currency Configuration Settings</a></td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#additionalfields">ADDITIONAL FIELDS</a></td><td>/v1/additionalfields</td><td align="center">-</td><td><a href="#additionalfields_list">List Additional Fields Sets</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/additionalfields/{Type}/{Set}/{id}</td><td><a href="#additionalfields_update">Update Additional Fields</a></td><td><a href="#additionalfields_retrieve">Retrieve Additional Fields</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#reports">REPORT</a></td><td>/v1/reports</td><td align="center">-</td><td><a href="#reports_list">List Reports</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/reports/{reportName}</td><td align="center">-</td><td><a href="#report_run">Run a Report</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#authentication">AUTHENTICATION</a></td><td>/v1/authentication</td><td><a href="#authentication_permissions">Verify Authentication</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#useraccounts">USER ACCOUNT</a></td><td>/v1/useraccounts/current</td><td align="center">-</td><td><a href="#useraccount_details_retrieve">Retrieve Current Users' Account Details</a></td><td><a href="#useraccount_details_update">Update Current Users' Account Details</a></td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/useraccounts/current/password</td><td align="center">-</td><td align="center">-</td><td><a href="#useraccount_password_update">Update Current Users' Password</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#users">USER</a></td><td>/v1/users</td><td><a href="#users_create">Create a User</a></td><td><a href="#users_list">List Users</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/users/{userId}</td><td align="center">-</td><td><a href="#users_retrieve">Retrieve a User</a></td><td><a href="#users_update">Update a User</a></td><td><a href="#users_delete">Delete a User</a></td></tr>
|
||||
<tr class="alt"><td><a href="#roles">ROLE</a></td><td>/v1/roles</td><td><a href="#roles_create">Create a New Role</a></td><td><a href="#roles_list">List Roles</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/roles/{roleId}</td><td align="center">-</td><td><a href="#roles_retrieve">Retrieve a Role</a></td><td><a href="#roles_update">Update a Role</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#permissions">PERMISSION</a></td><td>/v1/permissions</td><td align="center">-</td><td><a href="#permissions_list">List Application Permissions</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="flybar-nav">
|
||||
<h2 class="flybar-button">Report</h2>
|
||||
<div class="flybar-menu">go on then
|
||||
<div class="flybar-menu">
|
||||
<div class="tocMatrix">
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG"><td></td><td valign="top"><div class="matrixHeadingVerbs"><table><tr><td>Resources</td></tr></table></div></td><td><table><tr><td><div class="matrixHeadingVerbs">POST</div></td></tr><tr><td>create/update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">GET</div></td></tr><tr><td>read</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">PUT</div></td></tr><tr><td>simple update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">DELETE</div></td></tr><tr><td>delete</td></tr></table></td></tr>
|
||||
<tr><td><a href="#clients">CLIENT</a></td><td>/v1/clients</td><td><a href="api.htm#clients_create">Create a Client</a></td><td><a href="#clients_list">List Clients</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}</td><td align="center">-</td><td><a href="#clients_retrieve">Retrieve a Client</a></td><td><a href="#clients_update">Update a Client</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/loans</td><td align="center">-</td><td><a href="#clients_loansummary">Retrieve a Client's Loan Account Summary</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}/notes</td><td><a href="#clients_addnote">Add a Client Note</a></td><td><a href="#clients_notes">Retrieve a Client's Notes</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/notes/{noteId}</td><td align="center">-</td><td><a href="#clients_retrievenote">Retrieve a Client Note</a></td><td><a href="#clients_updatenote">Update a Client Note</a></td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#loans">LOAN</a></td><td>/v1/loans</td><td><a href="#loans_create">Create a New Loan/Submit a Loan Application</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}</td><td><a href="#loans_approve_etc">Approve, Disburse, Reject a Loan or Withdraw a Loan Application</a></td><td><a href="#loans_retrieve">Retrieve a Loan</a></td><td align="center">-</td><td><a href="#loans_delete">Delete a Loan</a></td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/undo</td><td><a href="#loans_undoapproval_etc">Undo Loan Approval or Disbursal</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}/transactions</td><td><a href="#loans_repayment_etc">Make a Repayment / Loan Waiver</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/transactions/{transactionId}</td><td align="center">-</td><td><a href="#loans_repaymentretrieve_etc">Retrieve a Repayment or Waiver Details</a></td><td><a href="#loans_repaymentadjust_etc">Adjust a Repayment or Waiver</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#offices">OFFICE</a></td><td>/v1/offices</td><td><a href="#offices_create">Create an Office</a></td><td><a href="#offices_list">List Offices</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/offices/{officeId}</td><td align="center">-</td><td><a href="#offices_retrieve">Retrieve an Office</a></td><td><a href="#offices_update">Update an Office</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#loanproducts">LOAN PRODUCT</a></td><td>/v1/loanproducts</td><td><a href="#loanproducts_create">Create a Loan Product</a></td><td><a href="#loanproducts_list">List Loan Products</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loanproducts/{productId}</td><td align="center">-</td><td><a href="#loanproducts_retrieve">Retrieve a Loan Product</a></td><td><a href="#loanproducts_update">Update a Loan Product</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#configs">CONFIGURATION</a></td><td>/v1/configurations/currency</td><td align="center">-</td><td><a href="#configs_currencyretrieve">Retrieve Currency Configuration Settings</a></td><td><a href="#configs_currencyupdate">Update Currency Configuration Settings</a></td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#additionalfields">ADDITIONAL FIELDS</a></td><td>/v1/additionalfields</td><td align="center">-</td><td><a href="#additionalfields_list">List Additional Fields Sets</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/additionalfields/{Type}/{Set}/{id}</td><td><a href="#additionalfields_update">Update Additional Fields</a></td><td><a href="#additionalfields_retrieve">Retrieve Additional Fields</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#reports">REPORT</a></td><td>/v1/reports</td><td align="center">-</td><td><a href="#reports_list">List Reports</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/reports/{reportName}</td><td align="center">-</td><td><a href="#report_run">Run a Report</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#authentication">AUTHENTICATION</a></td><td>/v1/authentication</td><td><a href="#authentication_permissions">Verify Authentication</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#useraccounts">USER ACCOUNT</a></td><td>/v1/useraccounts/current</td><td align="center">-</td><td><a href="#useraccount_details_retrieve">Retrieve Current Users' Account Details</a></td><td><a href="#useraccount_details_update">Update Current Users' Account Details</a></td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/useraccounts/current/password</td><td align="center">-</td><td align="center">-</td><td><a href="#useraccount_password_update">Update Current Users' Password</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#users">USER</a></td><td>/v1/users</td><td><a href="#users_create">Create a User</a></td><td><a href="#users_list">List Users</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/users/{userId}</td><td align="center">-</td><td><a href="#users_retrieve">Retrieve a User</a></td><td><a href="#users_update">Update a User</a></td><td><a href="#users_delete">Delete a User</a></td></tr>
|
||||
<tr class="alt"><td><a href="#roles">ROLE</a></td><td>/v1/roles</td><td><a href="#roles_create">Create a New Role</a></td><td><a href="#roles_list">List Roles</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/roles/{roleId}</td><td align="center">-</td><td><a href="#roles_retrieve">Retrieve a Role</a></td><td><a href="#roles_update">Update a Role</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#permissions">PERMISSION</a></td><td>/v1/permissions</td><td align="center">-</td><td><a href="#permissions_list">List Application Permissions</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="flybar-nav">
|
||||
<h2 class="flybar-button">User Related</h2>
|
||||
<div class="flybar-menu">go on then
|
||||
<div class="flybar-menu">
|
||||
<div class="tocMatrix">
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG"><td></td><td valign="top"><div class="matrixHeadingVerbs"><table><tr><td>Resources</td></tr></table></div></td><td><table><tr><td><div class="matrixHeadingVerbs">POST</div></td></tr><tr><td>create/update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">GET</div></td></tr><tr><td>read</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">PUT</div></td></tr><tr><td>simple update</td></tr></table></td><td><table><tr><td><div class="matrixHeadingVerbs">DELETE</div></td></tr><tr><td>delete</td></tr></table></td></tr>
|
||||
<tr><td><a href="#clients">CLIENT</a></td><td>/v1/clients</td><td><a href="api.htm#clients_create">Create a Client</a></td><td><a href="#clients_list">List Clients</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}</td><td align="center">-</td><td><a href="#clients_retrieve">Retrieve a Client</a></td><td><a href="#clients_update">Update a Client</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/loans</td><td align="center">-</td><td><a href="#clients_loansummary">Retrieve a Client's Loan Account Summary</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/clients/{clientId}/notes</td><td><a href="#clients_addnote">Add a Client Note</a></td><td><a href="#clients_notes">Retrieve a Client's Notes</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/clients/{clientId}/notes/{noteId}</td><td align="center">-</td><td><a href="#clients_retrievenote">Retrieve a Client Note</a></td><td><a href="#clients_updatenote">Update a Client Note</a></td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#loans">LOAN</a></td><td>/v1/loans</td><td><a href="#loans_create">Create a New Loan/Submit a Loan Application</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}</td><td><a href="#loans_approve_etc">Approve, Disburse, Reject a Loan or Withdraw a Loan Application</a></td><td><a href="#loans_retrieve">Retrieve a Loan</a></td><td align="center">-</td><td><a href="#loans_delete">Delete a Loan</a></td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/undo</td><td><a href="#loans_undoapproval_etc">Undo Loan Approval or Disbursal</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/loans/{loanId}/transactions</td><td><a href="#loans_repayment_etc">Make a Repayment / Loan Waiver</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loans/{loanId}/transactions/{transactionId}</td><td align="center">-</td><td><a href="#loans_repaymentretrieve_etc">Retrieve a Repayment or Waiver Details</a></td><td><a href="#loans_repaymentadjust_etc">Adjust a Repayment or Waiver</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#offices">OFFICE</a></td><td>/v1/offices</td><td><a href="#offices_create">Create an Office</a></td><td><a href="#offices_list">List Offices</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/offices/{officeId}</td><td align="center">-</td><td><a href="#offices_retrieve">Retrieve an Office</a></td><td><a href="#offices_update">Update an Office</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#loanproducts">LOAN PRODUCT</a></td><td>/v1/loanproducts</td><td><a href="#loanproducts_create">Create a Loan Product</a></td><td><a href="#loanproducts_list">List Loan Products</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/loanproducts/{productId}</td><td align="center">-</td><td><a href="#loanproducts_retrieve">Retrieve a Loan Product</a></td><td><a href="#loanproducts_update">Update a Loan Product</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#configs">CONFIGURATION</a></td><td>/v1/configurations/currency</td><td align="center">-</td><td><a href="#configs_currencyretrieve">Retrieve Currency Configuration Settings</a></td><td><a href="#configs_currencyupdate">Update Currency Configuration Settings</a></td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#additionalfields">ADDITIONAL FIELDS</a></td><td>/v1/additionalfields</td><td align="center">-</td><td><a href="#additionalfields_list">List Additional Fields Sets</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/additionalfields/{Type}/{Set}/{id}</td><td><a href="#additionalfields_update">Update Additional Fields</a></td><td><a href="#additionalfields_retrieve">Retrieve Additional Fields</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#reports">REPORT</a></td><td>/v1/reports</td><td align="center">-</td><td><a href="#reports_list">List Reports</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td></td><td>/v1/reports/{reportName}</td><td align="center">-</td><td><a href="#report_run">Run a Report</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td><a href="#authentication">AUTHENTICATION</a></td><td>/v1/authentication</td><td><a href="#authentication_permissions">Verify Authentication</a></td><td align="center">-</td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#useraccounts">USER ACCOUNT</a></td><td>/v1/useraccounts/current</td><td align="center">-</td><td><a href="#useraccount_details_retrieve">Retrieve Current Users' Account Details</a></td><td><a href="#useraccount_details_update">Update Current Users' Account Details</a></td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/useraccounts/current/password</td><td align="center">-</td><td align="center">-</td><td><a href="#useraccount_password_update">Update Current Users' Password</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#users">USER</a></td><td>/v1/users</td><td><a href="#users_create">Create a User</a></td><td><a href="#users_list">List Users</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/users/{userId}</td><td align="center">-</td><td><a href="#users_retrieve">Retrieve a User</a></td><td><a href="#users_update">Update a User</a></td><td><a href="#users_delete">Delete a User</a></td></tr>
|
||||
<tr class="alt"><td><a href="#roles">ROLE</a></td><td>/v1/roles</td><td><a href="#roles_create">Create a New Role</a></td><td><a href="#roles_list">List Roles</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
<tr><td></td><td>/v1/roles/{roleId}</td><td align="center">-</td><td><a href="#roles_retrieve">Retrieve a Role</a></td><td><a href="#roles_update">Update a Role</a></td><td align="center">-</td></tr>
|
||||
<tr class="alt"><td><a href="#permissions">PERMISSION</a></td><td>/v1/permissions</td><td align="center">-</td><td><a href="#permissions_list">List Application Permissions</a></td><td align="center">-</td><td align="center">-</td></tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="flybar-nav">
|
||||
<h2 class="flybar-button">Convenience API</h2>
|
||||
<div class="flybar-menu">go on then
|
||||
<div class="flybar-menu">
|
||||
<div class="tocMatrix">
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG"><td valign="top"><div class="matrixHeadingVerbs"><table><tr><td>Convenience Resources</td></tr></table></div></td><td><table><tr><td><div class="matrixHeadingVerbs">GET</div></td></tr><tr><td>read</td></tr></table></td></tr>
|
||||
<tr class="alt"><td>/v1/clients/template</td><td><a href="#clients_template">Retrieve Client Details Template</a></td></tr>
|
||||
<tr><td>/v1/loans/template</td><td><a href="#loans_template">Retrieve Loan Details Template</a></td></tr>
|
||||
<tr class="alt"><td>/v1/loans/{loanId}/transactions/template</td><td><a href="#loans_repaymenttemplate_etc">Retrieve Loan Repayment/Loan Waiver Template</a></td></tr>
|
||||
<tr><td>/v1/offices/template</td><td><a href="#offices_template">Retrieve Office Details Template</a></td></tr>
|
||||
<tr class="alt"><td>/v1/loanproducts/template</td><td><a href="#loanproducts_template">Retrieve Loan Product Details Template</a></td></tr>
|
||||
<tr><td>/v1/useraccounts/current/password/template</td><td><a href="#useraccount_password_retrieve">Retrieve change password template</a></td></tr>
|
||||
<tr class="alt"><td>/v1/users/template</td><td><a href="#users_template">Retrieve new user template</a></td></tr>
|
||||
<tr><td>/v1/roles/template</td><td><a href="#roles_template">Retrieve new role template</a></td></tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -82,7 +82,7 @@ body {
|
||||
height: 40px;
|
||||
min-width: 745px;
|
||||
left: 0; right: 0; top: 0;
|
||||
padding-left: 50px;
|
||||
padding-left: 100px;
|
||||
background: #eee;
|
||||
background: -webkit-gradient(linear, left top, left bottom, from(#f8f8f8), to(#dadada));
|
||||
background: -moz-linear-gradient(top, #f8f8f8, #dadada);
|
||||
@@ -141,7 +141,24 @@ body {
|
||||
position: absolute;
|
||||
top: 41px;
|
||||
|
||||
width: 900px;
|
||||
width: 800px;
|
||||
background-color: rgba(249, 249, 249, 0.99);
|
||||
border: 1px solid rgb(187, 187, 187);
|
||||
border-top: 0;
|
||||
padding: 1em;
|
||||
border-bottom-left-radius: 8px;
|
||||
border-bottom-right-radius: 8px;
|
||||
-webkit-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
-moz-box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
box-shadow: 0 3px 5px rgba(0,0,0,0.1);
|
||||
}
|
||||
|
||||
.flybar-menu-overview {
|
||||
display: none;
|
||||
position: absolute;
|
||||
top: 41px;
|
||||
|
||||
width: 300px;
|
||||
background-color: rgba(249, 249, 249, 0.99);
|
||||
border: 1px solid rgb(187, 187, 187);
|
||||
border-top: 0;
|
||||
@@ -170,24 +187,24 @@ body {
|
||||
margin-right: 25px;
|
||||
}
|
||||
|
||||
.flybar-menu h3 {
|
||||
.flybar-menu h3, .flybar-menu-overview h3 {
|
||||
text-transform: uppercase;
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
.flybar-menu h4 {
|
||||
.flybar-menu h4, , .flybar-menu-overview h4 {
|
||||
text-transform: uppercase;
|
||||
font-size: 90%;
|
||||
color: rgb(155, 155, 155);
|
||||
margin: 0.5em 0 0.5em 0;
|
||||
}
|
||||
|
||||
.flybar-menu ul {
|
||||
.flybar-menu ul, , .flybar-menu-overview ul {
|
||||
margin: 0 0 1em 1em;
|
||||
}
|
||||
|
||||
.flybar-nav:hover .flybar-menu,
|
||||
.flybar-nav.active .flybar-menu {
|
||||
.flybar-nav:hover .flybar-menu, .flybar-nav:hover .flybar-menu-overview,
|
||||
.flybar-nav.active .flybar-menu, .flybar-nav.active .flybar-menu-overview {
|
||||
display: block;
|
||||
}
|
||||
|
||||
@@ -202,7 +219,7 @@ body {
|
||||
border-right: 1px solid rgb(187, 187, 187);
|
||||
}
|
||||
|
||||
.flybar-nav:hover .flybar-menu,,
|
||||
.flybar-nav:hover .flybar-menu, .flybar-nav:hover .flybar-menu-overview,
|
||||
.flybar-button.active {
|
||||
margin-right: -1px;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user