diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 7ddfb1777..d884ab448 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -163,7 +163,7 @@
-
|
-
|
-
|
-
|
-
|
- ||||||||||
| GLOBAL CONFIGURATION | -configurations | -- | Retrieve - Global Configuration | -Update - Global Configuration | -- | |||||||||
| CODES | -codes | -Create a Code | -List Codes | -- | - | |||||||||
| - | codes/{codeId} | -- | Retrieve a Code | -Update a Code | -Delete a Code | -|||||||||
| CODE VALUES | -codes/{codeId}/codevalues | -Create a Code Value | -List Code Values | -- | - | |||||||||
| - | codes/{codeId}/codevalues/{codevalueId} | -- | Retrieve a Code Value | -Update a Code Value | -Delete a Code Value | -|||||||||
-
|
-
|
-
|
-
|
-
|
- ||||||||||
| DATA TABLE | -datatables | -- | List Data Tables | -- | - | |||||||||
| - | datatables/register/{datatable}/{apptable} | -Register Data Table | -- | - | - | |||||||||
| - | datatables/deregister/{datatable} | -Deregister Data - Table | -- | - | - | |||||||||
| - | datatables/{datatable}/{apptableId} | -Create Entry in Data - Table | -Retrieve Entry(s) - from Data Table | -Update Entry in Data - Table (One to One) | -Delete Entry(s) in - Data Table | -|||||||||
| - | datatables/{datatable}/{apptableId}/{datatableId} | -- | Update Entry in - Data Table (One to Many) | -- | Delete Entry in - Data Table (One to Many) | -|||||||||
| NOTES | -{resource}/{resourceId}/notes | -Add a Resource Note | -Retrieve a Resource's Notes | -- | - | |||||||||
| - | {resource}/{resourceId}/notes/{noteId} | -- | List All - Notes for a Resource | -Update a Resource Note | -Delete a Resource Note | -|||||||||
| Documents | -{entityType}/{entityId}/documents | -Create a Document | -List All Document Details | -- | - | |||||||||
| - | {entityType}/{entityId}/documents/{documentId} | -- | Retrieve a Documents Details | -Update a Document | -Delete a Document | -|||||||||
| - | {entityType}/{entityId}/documents/{documentId}/attachment | -- | Retrieve - binary file associated with a - Document - | -- | - | |||||||||
| SEARCH | -search | -- | Search Resources | -- | - | |||||||||
-
|
-
|
-
|
-
|
-
|
- ||||||||||
| REPORT | -reports | -- | List Reports | -- | - | |||||||||
| - | reports/{reportName} | -- | Run a Report | -- | - | |||||||||
-
|
-
|
-
|
-
|
-
|
- ||||||||||
| AUTHENTICATION | -authentication | -Verify Authentication | -- | - | - | |||||||||
| USER | -users | -Create a User | -List Users | -- | - | |||||||||
| - | users/{userId} | -- | Retrieve a User | -Update a User | -Delete a User | -|||||||||
| ROLE | -roles | -Create a New Role | -List Roles | -- | - | |||||||||
| - | roles/{roleId} | -- | Retrieve a Role | -Update a Role | -- | |||||||||
| - | roles/{roleId}/permissions | -- | Retrieve a - Role's Permissions | -Update a Role's - Permissions | -- | |||||||||
| PERMISSION | -permissions | -- | List Application - Permissions | -- | - | |||||||||
-
|
-
|
- |||
| clients/template | -Retrieve Client Template | -|||
| loanproducts/template | -Retrieve Loan Product Template | -|||
| loans/template?clientId={clientId} | -Retrieve Loan Template | -|||
| loans/{loanId}/transactions/template | -Retrieve Loan Transaction Template | -|||
| savingproducts/template | -Retrieve Savings Product Template | -|||
| savingsaccounts/template?clientId={clientId} | -Retrieve Savings Account Template | -|||
| offices/template | -Retrieve Office Template | -|||
| users/template | -Retrieve User Template | -|||
| audit/searchtemplate | -Retrieve Audit Search Data | -
+
|
+
|
+
|
+
|
+
|
+ ||||||||||
| Office | +offices | +Create an Office | +List Offices | ++ | + | |||||||||
| + | offices/{officeId} | ++ | Retrieve an Office | +Update an Office | ++ | |||||||||
| Loan Product | +loanproducts | +Create a Loan + Product | +List Loan Products | ++ | + | |||||||||
| + | loanproducts/{productId} | ++ | Retrieve a Loan + Product | +Update a Loan + Product | ++ | |||||||||
| Currency | +currencies | ++ | Retrieve + Currency Configuration | +Update Currency + Configuration | ++ | |||||||||
| Funds | +funds | +Create a Fund | +List Funds | ++ | + | |||||||||
| + | funds/{fundId} | ++ | Retrieve a Fund | +Update a Fund | ++ | |||||||||
| Staff | +staff | +Create a Staff | +List Staff | ++ | + | |||||||||
| + | staff/{staffId} | ++ | Retrieve a Staff Member | +Update a Staff Member | ++ | |||||||||
| Charges | +charges | +Create a Charge | +List Charges | ++ | + | |||||||||
| + | charges/{chargeId} | ++ | Retrieve a Charge | +Update a Charge | +Delete a Charge | +|||||||||
+
|
+
|
+
|
+
|
+
|
+ ||||||||||
| Authentication | +authentication | +Verify Authentication | ++ | + | + | |||||||||
| User | +users | +Create a User | +List Users | ++ | + | |||||||||
| + | users/{userId} | ++ | Retrieve a User | +Update a User | +Delete a User | +|||||||||
| Role | +roles | +Create a New Role | +List Roles | ++ | + | |||||||||
| + | roles/{roleId} | ++ | Retrieve a Role | +Update a Role | ++ | |||||||||
| + | roles/{roleId}/permissions | ++ | Retrieve a + Role's Permissions | +Update a Role's + Permissions | ++ | |||||||||
| Permission | +permissions | ++ | List Application + Permissions | ++ | + | |||||||||
+
|
+
|
+
|
+
|
+
|
+ ||||||||||
| Global Configuration | +configurations | ++ | Retrieve + Global Configuration | +Update + Global Configuration | ++ | |||||||||
| Codes | +codes | +Create a Code | +List Codes | ++ | + | |||||||||
| + | codes/{codeId} | ++ | Retrieve a Code | +Update a Code | +Delete a Code | +|||||||||
| Code Values | +codes/{codeId}/codevalues | +Create a Code Value | +List Code Values | ++ | + | |||||||||
| + | codes/{codeId}/codevalues/{codevalueId} | ++ | Retrieve a Code Value | +Update a Code Value | +Delete a Code Value | +|||||||||
+
|
+
|
+
|
+
|
+
|
+ ||||||||||
| Data Table | +datatables | ++ | List Data Tables | ++ | + | |||||||||
| + | datatables/register/{datatable}/{apptable} | +Register Data Table | ++ | + | + | |||||||||
| + | datatables/deregister/{datatable} | +Deregister Data + Table | ++ | + | + | |||||||||
| + | datatables/{datatable}/{apptableId} | +Create Entry in Data + Table | +Retrieve Entry(s) + from Data Table | +Update Entry in Data + Table (One to One) | +Delete Entry(s) in + Data Table | +|||||||||
| + | datatables/{datatable}/{apptableId}/{datatableId} | ++ | Update Entry in + Data Table (One to Many) | ++ | Delete Entry in + Data Table (One to Many) | +|||||||||
| Notes | +{resource}/{resourceId}/notes | +Add a Resource Note | +Retrieve a Resource's Notes | ++ | + | |||||||||
| + | {resource}/{resourceId}/notes/{noteId} | ++ | List All + Notes for a Resource | +Update a Resource Note | +Delete a Resource Note | +|||||||||
| Documents | +{entityType}/{entityId}/documents | +Create a Document | +List All Document Details | ++ | + | |||||||||
| + | {entityType}/{entityId}/documents/{documentId} | ++ | Retrieve a Documents Details | +Update a Document | +Delete a Document | +|||||||||
| + | {entityType}/{entityId}/documents/{documentId}/attachment | ++ | Retrieve + binary file associated with a + Document + | ++ | + | |||||||||
| Search | +search | ++ | Search Resources | ++ | + | |||||||||
+
|
+
|
+
|
+
|
+
|
+ ||||||||||
| Report | +reports | ++ | List Reports | ++ | + | |||||||||
| + | reports/{reportName} | ++ | Run a Report | ++ | + | |||||||||
+
|
+
|
+ |||
| clients/template | +Retrieve Client Template | +|||
| loanproducts/template | +Retrieve Loan Product Template | +|||
| loans/template?clientId={clientId} | +Retrieve Loan Template | +|||
| loans/{loanId}/transactions/template | +Retrieve Loan Transaction Template | +|||
| savingproducts/template | +Retrieve Savings Product Template | +|||
| savingsaccounts/template?clientId={clientId} | +Retrieve Savings Account Template | +|||
| offices/template | +Retrieve Office Template | +|||
| users/template | +Retrieve User Template | +|||
| audits/searchtemplate | +Retrieve Audit Search Template | +|||
| makercheckers/searchtemplate | +Retrieve Maker Checker Search Template | +