From 96528448896849cfd1dd7b74299005c91a35ec0a Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Thu, 4 Apr 2013 01:42:43 +0100 Subject: [PATCH] wip mifosx-270 audit/makerchecker api docs + minor doc changes --- api-docs/apiLive.htm | 1261 ++++++++++++++++++++++-------------------- api-docs/apidocs.css | 39 +- 2 files changed, 677 insertions(+), 623 deletions(-) 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 @@ - CLIENT + Client clients Create a Client List Clients @@ -229,7 +229,7 @@

Group

-
+
@@ -275,7 +275,7 @@
- GROUP + Group groups Create a Group List Groups @@ -527,8 +527,8 @@
-

Org

-
+

Savings

+
@@ -573,591 +573,13 @@
- - 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 -
- -
-

System

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
RESOURCES
-
- - - - - - -
POST
create/complex - update
 - - - - - - -
GET
read
 - - - - - - -
PUT
update
 - - - - - - -
DELETE
delete
GLOBAL CONFIGURATIONconfigurationsRetrieve - Global ConfigurationUpdate - Global Configuration
CODEScodesCreate a CodeList Codes
codes/{codeId}Retrieve a CodeUpdate a CodeDelete a Code
CODE VALUEScodes/{codeId}/codevaluesCreate a Code ValueList Code Values
codes/{codeId}/codevalues/{codevalueId}Retrieve a Code ValueUpdate a Code ValueDelete a Code Value
-
-
-
-
-

Non-Core

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
RESOURCES
-
- - - - - - -
POST
create/complex - update
 - - - - - - -
GET
read
 - - - - - - -
PUT
update
 - - - - - - -
DELETE
delete
DATA TABLEdatatablesList Data Tables
datatables/register/{datatable}/{apptable}Register Data Table
datatables/deregister/{datatable}Deregister Data - Table
datatables/{datatable}/{apptableId}Create Entry in Data - TableRetrieve Entry(s) - from Data TableUpdate 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}/notesAdd a Resource NoteRetrieve a Resource's Notes
{resource}/{resourceId}/notes/{noteId}List All - Notes for a ResourceUpdate a Resource NoteDelete a Resource Note
Documents{entityType}/{entityId}/documentsCreate a DocumentList All Document Details
{entityType}/{entityId}/documents/{documentId}Retrieve a Documents DetailsUpdate a DocumentDelete a Document
{entityType}/{entityId}/documents/{documentId}/attachmentRetrieve - binary file associated with a - Document -
SEARCHsearchSearch Resources
-
-
-
-
-

Report

-
-
- - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
RESOURCES
-
- - - - - - -
POST
create/complex - update
 - - - - - - -
GET
read
 - - - - - - -
PUT
update
 - - - - - - -
DELETE
delete
REPORTreportsList Reports
reports/{reportName}Run a Report
-
-
-
-
-

User

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
RESOURCES
-
- - - - - - -
POST
create/complex - update
 - - - - - - -
GET
read
 - - - - - - -
PUT
update
 - - - - - - -
DELETE
delete
AUTHENTICATIONauthenticationVerify Authentication
USERusersCreate a UserList Users
users/{userId}Retrieve a UserUpdate a UserDelete a User
ROLErolesCreate a New RoleList Roles
roles/{roleId}Retrieve a RoleUpdate a Role
roles/{roleId}/permissionsRetrieve a - Role's PermissionsUpdate a Role's - Permissions
PERMISSIONpermissionsList Application - Permissions
-
-
-
- -
-

Template

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
RESOURCES
-
- - - - - - -
GET
read
clients/templateRetrieve Client Template
loanproducts/templateRetrieve Loan Product Template
loans/template?clientId={clientId}Retrieve Loan Template
loans/{loanId}/transactions/templateRetrieve Loan Transaction Template
savingproducts/templateRetrieve Savings Product Template
savingsaccounts/template?clientId={clientId}Retrieve Savings Account Template
offices/templateRetrieve Office Template
users/templateRetrieve User Template
audit/searchtemplateRetrieve Audit Search Data
-
-
-
-

Accounting

-
+
@@ -1262,7 +684,636 @@ - +
+

Org

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
RESOURCES
+
+ + + + + + +
POST
create/complex + update
 + + + + + + +
GET
read
 + + + + + + +
PUT
update
 + + + + + + +
DELETE
delete
OfficeofficesCreate an OfficeList Offices
offices/{officeId}Retrieve an OfficeUpdate an Office
Loan ProductloanproductsCreate a Loan + ProductList Loan Products
loanproducts/{productId}Retrieve a Loan + ProductUpdate a Loan + Product
CurrencycurrenciesRetrieve + Currency ConfigurationUpdate Currency + Configuration
FundsfundsCreate a FundList Funds
funds/{fundId}Retrieve a FundUpdate a Fund
StaffstaffCreate a StaffList Staff
staff/{staffId}Retrieve a Staff MemberUpdate a Staff Member
ChargeschargesCreate a ChargeList Charges
charges/{chargeId}Retrieve a ChargeUpdate a ChargeDelete a Charge
+
+
+
+
+

User

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
RESOURCES
+
+ + + + + + +
POST
create/complex + update
 + + + + + + +
GET
read
 + + + + + + +
PUT
update
 + + + + + + +
DELETE
delete
AuthenticationauthenticationVerify Authentication
UserusersCreate a UserList Users
users/{userId}Retrieve a UserUpdate a UserDelete a User
RolerolesCreate a New RoleList Roles
roles/{roleId}Retrieve a RoleUpdate a Role
roles/{roleId}/permissionsRetrieve a + Role's PermissionsUpdate a Role's + Permissions
PermissionpermissionsList Application + Permissions
+
+
+
+
+

System

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
RESOURCES
+
+ + + + + + +
POST
create/complex + update
 + + + + + + +
GET
read
 + + + + + + +
PUT
update
 + + + + + + +
DELETE
delete
Global ConfigurationconfigurationsRetrieve + Global ConfigurationUpdate + Global Configuration
CodescodesCreate a CodeList Codes
codes/{codeId}Retrieve a CodeUpdate a CodeDelete a Code
Code Valuescodes/{codeId}/codevaluesCreate a Code ValueList Code Values
codes/{codeId}/codevalues/{codevalueId}Retrieve a Code ValueUpdate a Code ValueDelete a Code Value
+
+
+
+
+

Non-Core

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
RESOURCES
+
+ + + + + + +
POST
create/complex + update
 + + + + + + +
GET
read
 + + + + + + +
PUT
update
 + + + + + + +
DELETE
delete
Data TabledatatablesList Data Tables
datatables/register/{datatable}/{apptable}Register Data Table
datatables/deregister/{datatable}Deregister Data + Table
datatables/{datatable}/{apptableId}Create Entry in Data + TableRetrieve Entry(s) + from Data TableUpdate 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}/notesAdd a Resource NoteRetrieve a Resource's Notes
{resource}/{resourceId}/notes/{noteId}List All + Notes for a ResourceUpdate a Resource NoteDelete a Resource Note
Documents{entityType}/{entityId}/documentsCreate a DocumentList All Document Details
{entityType}/{entityId}/documents/{documentId}Retrieve a Documents DetailsUpdate a DocumentDelete a Document
{entityType}/{entityId}/documents/{documentId}/attachmentRetrieve + binary file associated with a + Document +
SearchsearchSearch Resources
+
+
+
+
+

Report

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
RESOURCES
+
+ + + + + + +
POST
create/complex + update
 + + + + + + +
GET
read
 + + + + + + +
PUT
update
 + + + + + + +
DELETE
delete
ReportreportsList Reports
reports/{reportName}Run a Report
+
+
+
+
+

Template

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
RESOURCES
+
+ + + + + + +
GET
read
clients/templateRetrieve Client Template
loanproducts/templateRetrieve Loan Product Template
loans/template?clientId={clientId}Retrieve Loan Template
loans/{loanId}/transactions/templateRetrieve Loan Transaction Template
savingproducts/templateRetrieve Savings Product Template
savingsaccounts/template?clientId={clientId}Retrieve Savings Account Template
offices/templateRetrieve Office Template
users/templateRetrieve User Template
audits/searchtemplateRetrieve Audit Search Template
makercheckers/searchtemplateRetrieve Maker Checker Search Template
+
+
+
@@ -12517,7 +12568,7 @@ GET https://DomainName/api/v1/search?query=000000111 - CURRENCY + Currency currencies Retrieve Currency @@ -12527,7 +12578,7 @@ GET https://DomainName/api/v1/search?query=000000111 - GLOBAL CONFIGURATION + Global Configuration configurations Retrieve @@ -12537,7 +12588,7 @@ GET https://DomainName/api/v1/search?query=000000111 - CODES + Codes codes Create a Code List Codes @@ -12553,7 +12604,7 @@ GET https://DomainName/api/v1/search?query=000000111 Delete a Code - CODE VALUES + Code Values codes/{codeId}/codevalues Create a Code Value List Code Values @@ -12569,7 +12620,7 @@ GET https://DomainName/api/v1/search?query=000000111 Delete a Code Value - FUNDS + Funds funds Create a Fund List Funds @@ -12585,7 +12636,7 @@ GET https://DomainName/api/v1/search?query=000000111 - STAFF + Staff staff Create a Staff List Staff @@ -12601,7 +12652,7 @@ GET https://DomainName/api/v1/search?query=000000111 - CHARGES + Charges charges Create a Charge List Charges @@ -12617,7 +12668,7 @@ GET https://DomainName/api/v1/search?query=000000111 Delete a Charge - DATA TABLE + Data Table datatables List Data Tables @@ -12690,7 +12741,7 @@ GET https://DomainName/api/v1/search?query=000000111 - NOTES + Notes {resource}/{resourceId}/notes Add a Resource Note Retrieve a Resource's Notes @@ -12707,7 +12758,7 @@ GET https://DomainName/api/v1/search?query=000000111 Delete a Resource Note - SEARCH + Search search Search Resources @@ -12771,7 +12822,7 @@ GET https://DomainName/api/v1/search?query=000000111 - REPORT + Report reports List Reports @@ -12787,7 +12838,7 @@ GET https://DomainName/api/v1/search?query=000000111 - AUTHENTICATION + Authentication authentication Verify Authentication @@ -12795,7 +12846,7 @@ GET https://DomainName/api/v1/search?query=000000111 - USER + User users Create a User List Users @@ -12811,7 +12862,7 @@ GET https://DomainName/api/v1/search?query=000000111 Delete a User - ROLE + Role roles Create a New Role List Roles @@ -12837,7 +12888,7 @@ GET https://DomainName/api/v1/search?query=000000111 - PERMISSION + Permission permissions List Permissions @@ -12896,13 +12947,17 @@ GET https://DomainName/api/v1/search?query=000000111 offices/template Retrieve Office Template - + users/template Retrieve User Template + + audits/searchtemplate + Retrieve Audit Search Template + - audit/searchtemplate - Retrieve Audit Search Template + makercheckers/searchtemplate + Retrieve Maker Checker Search Template
diff --git a/api-docs/apidocs.css b/api-docs/apidocs.css index 7497df0a3..5c942b270 100644 --- a/api-docs/apidocs.css +++ b/api-docs/apidocs.css @@ -209,7 +209,7 @@ body { top: 41px; max-height:550px; overflow:auto; - width: 850px; + width: 1000px; background-color: rgba(249, 249, 249, 0.99); border: 1px solid rgb(187, 187, 187); border-top: 0; @@ -244,23 +244,23 @@ body { position:absolute; left:-50px; } -#toc-menu-loan { +#toc-menu-group { position:absolute; left:-130px; } -#toc-menu-org { +#toc-menu-loan { position:absolute; left:-210px; } -#toc-menu-system { +#toc-menu-savings { position:absolute; left:-290px; } -#toc-menu-noncore { +#toc-menu-accounting { position:absolute; left:-370px; } -#toc-menu-report { +#toc-menu-org { position:absolute; left:-450px; } @@ -268,23 +268,22 @@ body { position:absolute; left:-530px; } +#toc-menu-system { + position:absolute; + left:-610px; +} +#toc-menu-noncore { + position:absolute; + left:-690px; +} +#toc-menu-report { + position:absolute; + left:-770px; +} #toc-menu-template { position:absolute; - left:-610px; + left:-850px; } -#toc-menu-account { - position:absolute; - left:-610px; -} -#toc-menu-group { - position:absolute; - left:-690px; -} -#toc-menu-savings { - position:absolute; - left:-690px; -} - #language-menu { left: -25px;