From 7bc94e446f392b9facb21abf02119e6c85858bf3 Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Wed, 23 May 2012 17:41:40 +1000 Subject: [PATCH] WIP api docs - matrix --- APIFolder/api.htm | 184 ++++++++++++++++++++++++++++------- APIFolder/apicss/apidocs.css | 33 +++++-- 2 files changed, 172 insertions(+), 45 deletions(-) diff --git a/APIFolder/api.htm b/APIFolder/api.htm index 62e4252c4..3a7c55dd8 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -12,70 +12,180 @@

Overview

-
go on then +
+
+
+ +
+

Core

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients--
/v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
/v1/clients/{clientId}/loans-Retrieve a Client's Loan Account Summary--
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes--
/v1/clients/{clientId}/notes/{noteId}-Retrieve a Client NoteUpdate a Client Note-
LOAN/v1/loansCreate a New Loan/Submit a Loan Application---
/v1/loans/{loanId}Approve, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
/v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
/v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
OFFICE/v1/officesCreate an OfficeList Offices--
/v1/offices/{officeId}-Retrieve an OfficeUpdate an Office-
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products--
/v1/loanproducts/{productId}-Retrieve a Loan ProductUpdate a Loan Product-
CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
/v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields--
REPORT/v1/reports-List Reports--
/v1/reports/{reportName}-Run a Report--
AUTHENTICATION/v1/authenticationVerify Authentication---
USER ACCOUNT/v1/useraccounts/current-Retrieve Current Users' Account DetailsUpdate Current Users' Account Details-
/v1/useraccounts/current/password--Update Current Users' Password-
USER/v1/usersCreate a UserList Users--
/v1/users/{userId}-Retrieve a UserUpdate a UserDelete a User
ROLE/v1/rolesCreate a New RoleList Roles--
/v1/roles/{roleId}-Retrieve a RoleUpdate a Role-
PERMISSION/v1/permissions-List Application Permissions--
+ + + + + + + + + + + + + + + + +
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients--
/v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
/v1/clients/{clientId}/loans-Retrieve a Client's Loan Account Summary--
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes--
/v1/clients/{clientId}/notes/{noteId}-Retrieve a Client NoteUpdate a Client Note-
LOAN/v1/loansCreate a New Loan/Submit a Loan Application---
/v1/loans/{loanId}Approve, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
/v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
/v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
OFFICE/v1/officesCreate an OfficeList Offices--
/v1/offices/{officeId}-Retrieve an OfficeUpdate an Office-
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products--
/v1/loanproducts/{productId}-Retrieve a Loan ProductUpdate a Loan Product-
-

Configuration

-
go on then +
+
+ + + +
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
+

Additional Fields

-
go on then +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients--
/v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
/v1/clients/{clientId}/loans-Retrieve a Client's Loan Account Summary--
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes--
/v1/clients/{clientId}/notes/{noteId}-Retrieve a Client NoteUpdate a Client Note-
LOAN/v1/loansCreate a New Loan/Submit a Loan Application---
/v1/loans/{loanId}Approve, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
/v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
/v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
OFFICE/v1/officesCreate an OfficeList Offices--
/v1/offices/{officeId}-Retrieve an OfficeUpdate an Office-
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products--
/v1/loanproducts/{productId}-Retrieve a Loan ProductUpdate a Loan Product-
CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
/v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields--
REPORT/v1/reports-List Reports--
/v1/reports/{reportName}-Run a Report--
AUTHENTICATION/v1/authenticationVerify Authentication---
USER ACCOUNT/v1/useraccounts/current-Retrieve Current Users' Account DetailsUpdate Current Users' Account Details-
/v1/useraccounts/current/password--Update Current Users' Password-
USER/v1/usersCreate a UserList Users--
/v1/users/{userId}-Retrieve a UserUpdate a UserDelete a User
ROLE/v1/rolesCreate a New RoleList Roles--
/v1/roles/{roleId}-Retrieve a RoleUpdate a Role-
PERMISSION/v1/permissions-List Application Permissions--
+

Report

-
go on then +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients--
/v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
/v1/clients/{clientId}/loans-Retrieve a Client's Loan Account Summary--
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes--
/v1/clients/{clientId}/notes/{noteId}-Retrieve a Client NoteUpdate a Client Note-
LOAN/v1/loansCreate a New Loan/Submit a Loan Application---
/v1/loans/{loanId}Approve, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
/v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
/v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
OFFICE/v1/officesCreate an OfficeList Offices--
/v1/offices/{officeId}-Retrieve an OfficeUpdate an Office-
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products--
/v1/loanproducts/{productId}-Retrieve a Loan ProductUpdate a Loan Product-
CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
/v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields--
REPORT/v1/reports-List Reports--
/v1/reports/{reportName}-Run a Report--
AUTHENTICATION/v1/authenticationVerify Authentication---
USER ACCOUNT/v1/useraccounts/current-Retrieve Current Users' Account DetailsUpdate Current Users' Account Details-
/v1/useraccounts/current/password--Update Current Users' Password-
USER/v1/usersCreate a UserList Users--
/v1/users/{userId}-Retrieve a UserUpdate a UserDelete a User
ROLE/v1/rolesCreate a New RoleList Roles--
/v1/roles/{roleId}-Retrieve a RoleUpdate a Role-
PERMISSION/v1/permissions-List Application Permissions--
+

User Related

-
go on then +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Resources
POST
create/update
GET
read
PUT
simple update
DELETE
delete
CLIENT/v1/clientsCreate a ClientList Clients--
/v1/clients/{clientId}-Retrieve a ClientUpdate a Client-
/v1/clients/{clientId}/loans-Retrieve a Client's Loan Account Summary--
/v1/clients/{clientId}/notesAdd a Client NoteRetrieve a Client's Notes--
/v1/clients/{clientId}/notes/{noteId}-Retrieve a Client NoteUpdate a Client Note-
LOAN/v1/loansCreate a New Loan/Submit a Loan Application---
/v1/loans/{loanId}Approve, Disburse, Reject a Loan or Withdraw a Loan ApplicationRetrieve a Loan-Delete a Loan
/v1/loans/{loanId}/undoUndo Loan Approval or Disbursal---
/v1/loans/{loanId}/transactionsMake a Repayment / Loan Waiver---
/v1/loans/{loanId}/transactions/{transactionId}-Retrieve a Repayment or Waiver DetailsAdjust a Repayment or Waiver-
OFFICE/v1/officesCreate an OfficeList Offices--
/v1/offices/{officeId}-Retrieve an OfficeUpdate an Office-
LOAN PRODUCT/v1/loanproductsCreate a Loan ProductList Loan Products--
/v1/loanproducts/{productId}-Retrieve a Loan ProductUpdate a Loan Product-
CONFIGURATION/v1/configurations/currency-Retrieve Currency Configuration SettingsUpdate Currency Configuration Settings-
ADDITIONAL FIELDS/v1/additionalfields-List Additional Fields Sets--
/v1/additionalfields/{Type}/{Set}/{id}Update Additional FieldsRetrieve Additional Fields--
REPORT/v1/reports-List Reports--
/v1/reports/{reportName}-Run a Report--
AUTHENTICATION/v1/authenticationVerify Authentication---
USER ACCOUNT/v1/useraccounts/current-Retrieve Current Users' Account DetailsUpdate Current Users' Account Details-
/v1/useraccounts/current/password--Update Current Users' Password-
USER/v1/usersCreate a UserList Users--
/v1/users/{userId}-Retrieve a UserUpdate a UserDelete a User
ROLE/v1/rolesCreate a New RoleList Roles--
/v1/roles/{roleId}-Retrieve a RoleUpdate a Role-
PERMISSION/v1/permissions-List Application Permissions--
+

Convenience API

-
go on then +
+
+ + + + + + + + + + +
Convenience Resources
GET
read
/v1/clients/templateRetrieve Client Details Template
/v1/loans/templateRetrieve Loan Details Template
/v1/loans/{loanId}/transactions/templateRetrieve Loan Repayment/Loan Waiver Template
/v1/offices/templateRetrieve Office Details Template
/v1/loanproducts/templateRetrieve Loan Product Details Template
/v1/useraccounts/current/password/templateRetrieve change password template
/v1/users/templateRetrieve new user template
/v1/roles/templateRetrieve new role template
+
diff --git a/APIFolder/apicss/apidocs.css b/APIFolder/apicss/apidocs.css index 0fa22aab7..865abf5f2 100644 --- a/APIFolder/apicss/apidocs.css +++ b/APIFolder/apicss/apidocs.css @@ -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; }