From 1f7cd4d293edc2bc8d2b83ade3d08caa65fb2895 Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Mon, 29 Apr 2013 10:22:46 +0100 Subject: [PATCH] update api-docs (mostly reports tempplate) --- api-docs/apiLive.htm | 111 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 105 insertions(+), 6 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 1baf13430..d776ea6bd 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -1374,22 +1374,30 @@ savingsaccounts/template?clientId={clientId} Retrieve Savings Account Template - + + savingsaccounts/{accountId}/transactions/template + Retrieve Savings Account Transaction Template + + offices/template Retrieve Office Template - + users/template Retrieve User Template - + audits/searchtemplate Retrieve Audit Search Template - + makercheckers/searchtemplate Retrieve Maker Checker Search Template + + reports/template + Retrieve Report Template + @@ -10984,6 +10992,84 @@ No Request Body: +   +
+
+

Retrieve Report Template

+

This is a convenience resource. It can be useful when + building maintenance user interface screens for client + applications. The template data returned consists of any or all + of: +

    +
  • Field Defaults
  • +
  • Allowed Value Lists
  • +
+

+

Example Request:

+
reports/template
+
+
+ +GET https://DomainName/api/v1/reports/template + + +{ + "allowedReportTypes": [ + "Table", + "Pentaho", + "Chart" + ], + "allowedReportSubTypes": [ + "Bar", + "Pie" + ], + "allowedParameters": [ + { + "id": 1, + "parameterName": "startDateSelect" + }, + { + "id": 2, + "parameterName": "endDateSelect" + }, + { + "id": 3, + "parameterName": "obligDateTypeSelect" + }, + { + "id": 5, + "parameterName": "OfficeIdSelectOne" + }, + { + "id": 6, + "parameterName": "loanOfficerIdSelectAll" + }, + { + "id": 10, + "parameterName": "currencyIdSelectAll" + }, + { + "id": 20, + "parameterName": "fundIdSelectAll" + }, + { + "id": 25, + "parameterName": "loanProductIdSelectAll" + }, + { + "id": 26, + "parameterName": "loanPurposeIdSelectAll" + }, + { + "id": 100, + "parameterName": "parTypeSelect" + } + ] +} + +
+
+  
@@ -11090,7 +11176,8 @@ GET https://DomainName/api/v1/reports

Retrieve a Report

Example Requests:

-
reports/1
+
reports/1


+
reports/1?template=true
@@ -13961,6 +14048,14 @@ GET https://DomainName/api/v1/search?query=000000111 + + centers/template + Retrieve Center Template + + + groups/template + Retrieve Group Template + clients/template Retrieve Client Template @@ -13975,7 +14070,7 @@ GET https://DomainName/api/v1/search?query=000000111 loans/{loanId}/transactions/template - Retrieve Tranaction Template + Retrieve Loan Transaction Template savingproducts/template @@ -14005,6 +14100,10 @@ GET https://DomainName/api/v1/search?query=000000111 makercheckers/searchtemplate Retrieve Maker Checker Search Template + + reports/template + Retrieve Report Template +