From 94baf15b976677cb74479e4a1444620d3c1f515b Mon Sep 17 00:00:00 2001 From: Satish Date: Wed, 14 Dec 2016 18:13:24 +0530 Subject: [PATCH] API DOC UPDATE FOR WORKFLOW --- api-docs/apiLive.htm | 792 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 781 insertions(+), 11 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 467d6c543..41ad457d9 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -2072,7 +2072,7 @@ - tr> + smscampaigns/{campaignId} @@ -2104,6 +2104,38 @@ + + Entity-Datatable Checks + entityDatatableChecks + Create an Entity-Datatable Check + + + + + + + entityDatatableChecks?limit=15&offset=0 + + List Entity-Datatable Checks + + + + + + entityDatatableChecks/template + + Retrieves an Entity-Datatable Check template + + + + + + entityDatatableChecks/{entityDatatableCheckId} + + + + Delete an Entity-Datatable Check + Currency currencies @@ -4492,6 +4524,13 @@ Successful transaction response: Optional: Default overdraft savings account of client + + datatables + + + Facility to enrich client details. + + @@ -4559,7 +4598,65 @@ GET https://DomainName/api/v1/clients/template "name":"account overdraft", "withdrawalFeeForTransfers":false, "allowOverdraft":false - }] + }], + "datatables": [{ + "applicationTableName": "m_client", + "registeredTableName": "Address Details", + "columnHeaderData": [{ + "columnName": "client_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "State", + "columnType": "varchar", + "columnLength": 25, + "columnDisplayType": "STRING", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "COUNTRY_cd_Country", + "columnType": "int", + "columnLength": 0, + "columnDisplayType": "CODELOOKUP", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [{ + "id": 17, + "value": "India", + "score": 0 + }], + "columnCode": "COUNTRY" + }] + }, + { + "applicationTableName": "m_client", + "registeredTableName": "Client Timeline", + "columnHeaderData": [{ + "columnName": "client_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "Approval Data", + "columnType": "date", + "columnLength": 0, + "columnDisplayType": "DATE", + "isColumnNullable": true, + "isColumnPrimaryKey": false, + "columnValues": [] + }] + }] } @@ -4592,6 +4689,64 @@ GET https://DomainName/api/v1/clients/template "name":"account overdraft", "withdrawalFeeForTransfers":false, "allowOverdraft":false + }], + "datatables": [{ + "applicationTableName": "m_client", + "registeredTableName": "Address Details", + "columnHeaderData": [{ + "columnName": "client_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "State", + "columnType": "varchar", + "columnLength": 25, + "columnDisplayType": "STRING", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "COUNTRY_cd_Country", + "columnType": "int", + "columnLength": 0, + "columnDisplayType": "CODELOOKUP", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [{ + "id": 17, + "value": "India", + "score": 0 + }], + "columnCode": "COUNTRY" + }] + }, + { + "applicationTableName": "m_client", + "registeredTableName": "Client Timeline", + "columnHeaderData": [{ + "columnName": "client_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "Approval Data", + "columnType": "date", + "columnLength": 0, + "columnDisplayType": "DATE", + "isColumnNullable": true, + "isColumnPrimaryKey": false, + "columnValues": [] + }] }] } @@ -4739,7 +4894,65 @@ GET https://DomainName/api/v1/clients/template ] }, "isAddressEnabled": true - } + }, + "datatables": [{ + "applicationTableName": "m_client", + "registeredTableName": "Address Details", + "columnHeaderData": [{ + "columnName": "client_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "State", + "columnType": "varchar", + "columnLength": 25, + "columnDisplayType": "STRING", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "COUNTRY_cd_Country", + "columnType": "int", + "columnLength": 0, + "columnDisplayType": "CODELOOKUP", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [{ + "id": 17, + "value": "India", + "score": 0 + }], + "columnCode": "COUNTRY" + }] + }, + { + "applicationTableName": "m_client", + "registeredTableName": "Client Timeline", + "columnHeaderData": [{ + "columnName": "client_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "Approval Data", + "columnType": "date", + "columnLength": 0, + "columnDisplayType": "DATE", + "isColumnNullable": true, + "isColumnPrimaryKey": false, + "columnValues": [] + }] + }] @@ -4796,7 +5009,31 @@ Content-Type: application/json Request Body: "active": true, "activationDate": "04 March 2009", "submittedOnDate":"04 March 2009", - "savingsProductId" : 4 + "savingsProductId" : 4, + "datatables": [{ + "registeredTableName": "Family Details", + "data": { + "locale": "en", + "Number of members": "5", + "Number of dependents": "3", + "No of Children": "2", + "Date of verification": "14 December 2016", + "dateFormat": "dd MMMM yyyy" + } + }, + { + "registeredTableName": "Residency Address", + "data": { + "locale": "en", + "Address Line": "Basavana Gudi Road", + "Street": "Gandhi Bazaar", + "Landmark": "Aashrama", + "COUNTRY_cd_Country": 17, + "STATE_cd_State": "7", + "DISTRICT_cd_District": "13", + "Pincode": "560040" + } + }] } @@ -7592,6 +7829,13 @@ GET https://DomainName/fineract-provider/api/v1/centers?paged=true The details of any bulk disbursement transactions. + + datatables + + + Facility to enrich group details. + + @@ -7676,7 +7920,66 @@ GET https://DomainName/fineract-provider/api/v1/groups/template "officeId": 1, "officeName": "Head Office" } - ] + ], + "datatables": [{ + "applicationTableName": "m_group", + "registeredTableName": "Group Activation Data", + "columnHeaderData": [{ + "columnName": "group_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "GROUPROLE_cd_Ctry", + "columnType": "int", + "columnLength": 0, + "columnDisplayType": "CODELOOKUP", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [{ + "id": 13, + "value": "Leader", + "score": 0 + }, + { + "id": 16, + "value": "Leader1", + "score": 0 + }, + { + "id": 14, + "value": "Collector", + "score": 0 + }], + "columnCode": "GROUPROLE" + }] + }, + { + "applicationTableName": "m_group", + "registeredTableName": "Group Enrichment", + "columnHeaderData": [{ + "columnName": "group_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "name", + "columnType": "varchar", + "columnLength": 15, + "columnDisplayType": "STRING", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }] + }] } @@ -7778,7 +8081,23 @@ Content-Type: application/json Request Body: "locale": "en", "active": true, "activationDate": "04 March 2009", - "submittedOnDate":"04 March 2009" + "submittedOnDate":"04 March 2009", + "datatables": [{ + "registeredTableName": "Address Details", + "data": { + "locale": "en", + "COUNTRY_cd_Country": 17 + } + }, + { + "registeredTableName": "Group Activation Data", + "data": { + "locale": "en", + "GROUPROLE_cd_Ctry": 13, + "Date": "01 December 2016", + "dateFormat": "dd MMMM yyyy" + } + }] } @@ -9478,7 +9797,60 @@ GET https://DomainName/api/v1/loans/template?templateType=individual&clientId=1& "fieldOfficerId":0, "currency":{"code":"USD","name":"US Dollar","decimalPlaces":2,"displaySymbol":"$","nameCode":"currency.USD","displayLabel":"US Dollar ($)"} } - ] + ], + "datatables": [{ + "applicationTableName": "m_loan", + "registeredTableName": "loan_balance", + "columnHeaderData": [{ + "columnName": "loan_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "account_number", + "columnType": "varchar", + "columnLength": 25, + "columnDisplayType": "STRING", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "Balance", + "columnType": "decimal", + "columnLength": 0, + "columnDisplayType": "DECIMAL", + "isColumnNullable": true, + "isColumnPrimaryKey": false, + "columnValues": [] + }] + }, + { + "applicationTableName": "m_loan", + "registeredTableName": "Loan Enrichment", + "columnHeaderData": [{ + "columnName": "loan_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "Activation Date", + "columnType": "date", + "columnLength": 0, + "columnDisplayType": "DATE", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }] + }] } @@ -10245,6 +10617,14 @@ Request Body: recalculationCompoundingFrequencyDate + + + + + + + +
Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan.
datatables

@@ -10288,7 +10668,26 @@ Request Body: "fixedEmiAmount":1100, "maxOutstandingLoanBalance":"35000", "disbursementData":[{"expectedDisbursementDate":"01 November 2013", - "principal":22000,"approvedPrincipal":22000}] + "principal":22000,"approvedPrincipal":22000}], + "datatables": [{ + "registeredTableName": "loan_balance", + "data": { + "locale": "en", + "account_number": "0000001", + "Balance": "3300.00", + "DateField": "01 December 2016 00:00", + "dateFormat": "dd MMMM yyyy HH:mm", + "DateTimeField": "01 December 2016 12:00" + } + }, + { + "registeredTableName": "Date Loan Field", + "data": { + "locale": "en", + "Activation Date": "01 December 2016 00:00", + "dateFormat": "dd MMMM yyyy HH:mm" + } + }] } @@ -21077,6 +21476,312 @@ Content-Type: application/json +   +
+
+

Entity-Datatable Checks

+

This defines Entity-Datatable Check.

+ +
+ + + + + + + + + + + + + +
Field Descriptions
entity
The entity to which the Entity-Datatable Check to be attached.
status
The action to be attached to an Entity-Datatable Check.
datatableName
Name of the datatable on which the Entity-Datatable Check to be imposed.
productId
Optional: The product to be associated with an entity.
+ + + +   +
+
+

Create Entity-Datatable Checks

+ + + + + +
Mandatory Fields
entity, status, datatableName
+
+ + + + + +
Non-Mandatory Fields
productId
+
+ +
+ POST https://Domain Name/api/v1/entityDatatableChecks + POST entitydatatablechecks +Content-Type: application/json +Request Body: +{ +"entity": "m_loan", +"status": 100, +"datatableName": "Additional Details", +"productId": 1 +} + + + +{ +"resourceId": 1 +} + + +
+
+ +   +
+
+

List Entity-Datatable Checks

+

The list capability of Entity-Datatable Checks can support pagination.

+
Optional Arguments
+
+
offset
+
+ Integer optional, defaults to 0 +
+
Indicates the result from which pagination starts
+ +
limit
+
+ Integer optional, defaults to 200 +
+
Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1
+
+

Example Request:

+
entityDatatableChecks?offset=0&limit=15
+
+
+ GET https://DomainName/api/v1/entityDatatableChecks?offset=0&limit=15 + + +{ +"totalFilteredRecords": 15, +"pageItems": [{ +"id": 45, +"entity": "m_client", +"status": { +"id": 100, +"code": "CREATE", +"value": "CREATE" +}, +"datatableName": "Client Personal Details", +"systemDefined": false, +"order": 45 +}, +{ +"id": 48, +"entity": "m_group", +"status": { +"id": 100, +"code": "CREATE", +"value": "CREATE" +}, +"datatableName": "Group Activation Details", +"systemDefined": false, +"order": 48 +}, ...] +} + +
+
+ +   +
+
+

Retrieve Entity-Datatable Checks Template

+

This is a convenience resource useful for + building maintenance user interface screens for Entity-Datatable Checks + applications. The template data returned consists of: +

    +
  • Allowed Value Lists
    • +
+

+

Example Request:

+
entityDatatableChecks/template
+
+
+ GET https://DomainName/api/v1/entityDatatableChecks/template + + +{ +"entities": ["m_client", +"m_loan", +"m_group", +"m_savings_account"], +"statusClient": [{ +"name": "CREATE", +"code": 100 +}, +{ +"name": "ACTIVATE", +"code": 300 +}, +{ +"name": "CLOSE", +"code": 600 +}], +"statusGroup": [{ +"name": "CREATE", +"code": 100 +}, +{ +"name": "ACTIVATE", +"code": 300 +}, +{ +"name": "CLOSE", +"code": 600 +}], +"statusSavings": [{ +"name": "CREATE", +"code": 100 +}, +{ +"name": "APPROVE", +"code": 200 +}, +{ +"name": "ACTIVATE", +"code": 300 +}, +{ +"name": "WITHDRAWN", +"code": 400 +}, +{ +"name": "REJECTED", +"code": 500 +}, +{ +"name": "CLOSE", +"code": 600 +}], +"statusLoans": [{ +"name": "CREATE", +"code": 100 +}, +{ +"name": "APPROVE", +"code": 200 +}, +{ +"name": "ACTIVATE", +"code": 300 +}, +{ +"name": "WITHDRAWN", +"code": 400 +}, +{ +"name": "REJECTED", +"code": 500 +}, +{ +"name": "WRITE_OFF", +"code": 601 +}], +"datatables": [{ +"entity": "m_group", +"dataTableName": "Address Details" +}, +{ +"entity": "m_client", +"dataTableName": "CACT" +}, +{ +"entity": "m_client", +"dataTableName": "Family_Details" +}], +"loanProductDatas": [{ +"id": 1, +"name": "Sakhi Shakthi", +"includeInBorrowerCycle": false, +"useBorrowerCycle": false, +"isLinkedToFloatingInterestRates": false, +"isFloatingInterestRateCalculationAllowed": false, +"allowVariableInstallments": false, +"isInterestRecalculationEnabled": false, +"canDefineInstallmentAmount": false, +"principalVariationsForBorrowerCycle": [], +"interestRateVariationsForBorrowerCycle": [], +"numberOfRepaymentVariationsForBorrowerCycle": [], +"canUseForTopup": false, +"holdGuaranteeFunds": false, +"accountMovesOutOfNPAOnlyOnArrearsCompletion": false, +"syncExpectedWithDisbursementDate": false +}, +{ +"id": 2, +"name": "MEL One", +"includeInBorrowerCycle": false, +"useBorrowerCycle": false, +"isLinkedToFloatingInterestRates": false, +"isFloatingInterestRateCalculationAllowed": false, +"allowVariableInstallments": false, +"isInterestRecalculationEnabled": false, +"canDefineInstallmentAmount": false, +"principalVariationsForBorrowerCycle": [], +"interestRateVariationsForBorrowerCycle": [], +"numberOfRepaymentVariationsForBorrowerCycle": [], +"canUseForTopup": false, +"holdGuaranteeFunds": false, +"accountMovesOutOfNPAOnlyOnArrearsCompletion": false, +"syncExpectedWithDisbursementDate": false +}], +"savingsProductDatas": [{ +"id": 1, +"name": "Deposit Account", +"withdrawalFeeForTransfers": false, +"allowOverdraft": false, +"enforceMinRequiredBalance": false, +"withHoldTax": false +}, +{ +"id": 2, +"name": "Savings Account One", +"withdrawalFeeForTransfers": false, +"allowOverdraft": false, +"enforceMinRequiredBalance": false, +"withHoldTax": false +}] +} + +
+
+ +   +
+
+

Delete Entity-Datatable Checks

+

+ Deletes an existing Entity-Datatable Check +

+
+ +
+ DELETE https://Domain Name/api/v1/entityDatatableChecks/{entityDatatableCheckId} + +{ +"resourceId": 1 +} + +
+
+  
@@ -24600,6 +25305,8 @@ No Request Body: withHoldTax Optional: If tax group provided at product level, will allow to Enable or disable withhold tax on interest posting for savings account + datatables + Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings.
@@ -24941,7 +25648,43 @@ No Request Body: ], "feeInterval": 4 } - ] + ], + "datatables": [{ + "applicationTableName": "m_savings_account", + "registeredTableName": "Savings Address Enrichment", + "columnHeaderData": [{ + "columnName": "savings_account_id", + "columnType": "bigint", + "columnLength": 0, + "columnDisplayType": "INTEGER", + "isColumnNullable": false, + "isColumnPrimaryKey": true, + "columnValues": [] + }, + { + "columnName": "Name", + "columnType": "varchar", + "columnLength": 25, + "columnDisplayType": "STRING", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "COUNTRY_cd_country details", + "columnType": "int", + "columnLength": 0, + "columnDisplayType": "CODELOOKUP", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [{ + "id": 17, + "value": "India", + "score": 0 + }], + "columnCode": "COUNTRY" + }] + }] }
@@ -24967,6 +25710,15 @@ No Request Body: nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax +
+ + + + + + + +
Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings.
datatables

Minimal request: accountNo auto generated, remaining details inherited from savings product.

@@ -25019,7 +25771,25 @@ Request Body: "lockinPeriodFrequencyType": 2, "allowOverdraft":true, "overdraftLimit":5000, - "charges":[{"id":"1"}] + "charges":[{"id":"1"}], + "datatables": [{ + "registeredTableName": "Savings Enrichment", + "data": { + "locale": "en", + "Name": "Raj", + "COUNTRY_cd_country details": 17 + } + }, + { + "registeredTableName": "SavingsDataTableCreate", + "data": { + "locale": "en", + "Volume": "25", + "CurrentTimestamp": "01 December 2016 12:44", + "dateFormat": "dd MMMM yyyy HH:mm", + "DateData": "01 December 2016 00:00" + } + }] } @@ -47009,7 +47779,7 @@ No Request Body: Search search - Search Resources + Search Resources