diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 087d6eece..d8e4598af 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -1406,6 +1406,14 @@
AdHoc Query search supported parameters and field descriptions
+Field Descriptions |
+
| entities | +
| Entities to be included for search.(presently support added only for loans) |
+
| loanStatus | +
| Loan status values to be included for search. + Supported loan status:["all","active","overpaid","closed","writeoff"] + |
+
| loanProducts | +
| Array of loanproduct ids. + | +
| offices | +
| Array of office ids. + | +
| loanDateOption | +
| Date condition name for search query. + Supported values "approvalDate" or "createdDate" or "disbursalDate". + |
+
| loanFromDate | +
| Start date for 'loanDateOption' in 'yyyy-MM-dd' format. | +
| loanToDate | +
| End date for 'loanDateOption' in 'yyyy-MM-dd' format. | +
| includeOutStandingAmountPercentage | +
| It is a Boolean value, allows to search percentage of loan outstanding amount with in a given range | +
| outStandingAmountPercentageCondition | +
| Condition type for outstanding amount percentage.
+ Supported values: between or <= or >= or < or > or = + When 'outStandingAmountPercentageCondition' is between required fields minOutStandingAmountPercentage and maxOutStandingAmountPercentage + |
+
| minOutStandingAmountPercentage | +
| Minimum percentage of outstanding amount. Mandatory when 'outStandingAmountPercentageCondition' type is 'between' |
+
| maxOutStandingAmountPercentage | +
| Maximum percentage of outstanding amount. Mandatory when 'outStandingAmountPercentageCondition' type is 'between' |
+
| outStandingAmountPercentage | +
| Percentage of outstanding amount for search. Mandatory when 'outStandingAmountPercentageCondition' type is otherthan 'between' |
+
| includeOutstandingAmount | +
| Boolean value, allows user to search loan outstanding amount with in a given range | +
| outstandingAmountCondition | +
| Condition type to search outstanding amount.
+ Supported values: between or <= or >= or < or > or = + When 'outstandingAmountCondition' is between required fields minOutStandingAmount and maxOutStandingAmount + |
+
| minOutStandingAmount | +
| Minimum value of outstanding amount for outstandingAmountCondition type between. Mandatory when 'outstandingAmountCondition' type is 'between' |
+
| maxOutStandingAmount | +
| Maximum value of outstanding amount for outstandingAmountCondition type between. Mandatory when 'outstandingAmountCondition' type is 'between' |
+
| outStandingAmount | +
| Default value of outstanding amount for search. Mandatory when 'outstandingAmountCondition' type is otherthan 'between' |
+
+ AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters
+
Mandatory Fields |
+
| entities | +
Optional Fields |
+
|
+ loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, + minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, + minOutstandingAmount and maxOutstandingAmount OR outstandingAmount |
+
+POST https://DomainName/api/v1/search/advance
+
+
+POST search/advance
+Content-Type: application/json Request Body:
+{
+ "locale": "en",
+ "dateFormat": "yyyy-MM-dd",
+ "entities": ["loans"],
+ "loanStatus": ["all","active","overpaid"],
+ "loanProducts": ["65","97","73","82"],
+ "offices": ["1","10","100"],
+ "loanDateOption": "approvalDate",
+ "loanFromDate": "2013-01-01",
+ "loanToDate": "2014-01-27",
+ "includeOutStandingAmountPercentage": true,
+ "outStandingAmountPercentageCondition": "<=",
+ "outStandingAmountPercentage": "80",
+ "includeOutstandingAmount": true,
+ "outstandingAmountCondition": "between",
+ "minOutstandingAmount": "100",
+ "maxOutstandingAmount": "10000"
+}
+
+
+[{
+ "officeName": "HFC",
+ "loanProductName": "01 BC3M",
+ "count": 86,
+ "loanOutStanding": 5692.41,
+ "percentage": 76.4
+},
+{
+ "officeName": "keithoffice",
+ "loanProductName": "IGL",
+ "count": 3,
+ "loanOutStanding": 4168.23,
+ "percentage": 56.9
+},
+{
+ "officeName": "Rio",
+ "loanProductName": "IGL",
+ "count": 1,
+ "loanOutStanding": 1681.12,
+ "percentage": 55.56
+}]
+
+