9 PA Mertics

(Required) <Enter a short description here.>

Endpoint (HTTP Link): http://<hostname>:<port>/rest-api/pa/v1/metric/post

Service Type: POST

Request JSON Prameters:

The following Request Parameters are Mandatory Parameters:

• SERVICE_TYPE

  String

  PERFORMANCE_METRICS for retrieving Metrics for an existing Account.

  Or

  SEGMENTATION for retrieving Segment of an existing Account.

• OPERATION_TYPE

  String

  ACCOUNT (hard coded for future provision)

• ACTION_TYPE

  String

  LOOKUP (hard coded for future provision)

• REQUEST_NUMBER

  Number

  A unique integer number. Should change each time.

• PARAMS
  • PARAM_CODE

    String

    "PARAMS": [

    {

    "PARAM_CODE": "INFODOM", "PARAM_VALUE": "<VALUE OF INFODOM>"

    },

    {

    "PARAM_CODE": "FOLDER", "PARAM_VALUE": "<VALUE OF FOLDER>"

    }

    ]

    The VALUE OF FOLDER is not currently used. It is recommended to use DEFAULT for this parameter.

• PAYLOAD
  • PARTY
    • PARTY_ID

      String

      Customer ID

    When PARTY_ID is not passed, it should be passed as NULL. Web Service will not accept blank value for this parameter.

  • PARTY_ATTRIBUTES

    String

    This is not used. Give NULL as the parameter.

  • ACCOUNTS
    • ACCOUNT_NUMBER

      String

      When ACCOUNT_NUMBER is not passed, it should be passed as NULL. Web Service will not accept blank value for this parameter.

  • EXEC_PARAMS
    • PARAM_CODE

      String

      Pass AS_OF_DATE.

    • PARAM_VALUE

      String

      Provide the Date on which you want the metrics in YYYYMMDD format.

  • ACCOUNTS
    • ACCOUNT_ATTRIBUTES

      CUSTOMER_TYPE

      String

      Accepted values are:

      • I: Institutional
      • R: Retail

      SEGMENT_TYPE

      String

      Accepted values are:

      • D: Demographic
      • P: Profitability
      • B: Behavioral
      • R: Risk
      • C: Corporate

The following Request Parameters are Optional Parameters:

• V_PROD_CODE
• N_AGE
• V_GENDER
• V_MARITAL_STATUS
• V_INDUSTRY
• V_COUNTRY
• N_INCOME
• N_NIBT
• N_LTV
• N_EOP_BAL
• N_ENHANCED_LTV F_UPGRADE_IND
• N_TOTAL_TRANSACTIONS
• N_AVERAGE_TRANSACTION_SIZE
• N_CUSTOMER_MOB
• N_LIMIT_UTILIZATION
• N_CREDIT_SCORE
• N_MITIGANT_VALUE
• N_DELINQUENT_DAYS
• N_LOAN_TO_VALUE
• V_PRIMARY_OR_SECONDARY_CUST
• N_YEAR_OF_INCORPORATION
• N_CUSTOMER_INCOME
• N_TOTAL_ASSETS
• F_CUSTOMER_LISTED_FLG
• N_EMPLOYEES
• N_TOTAL_ACCOUNTS
• N_RAROC
• N_ROTA
• V_CREDIT_RATING_CODE
• N_DEBT_COVERAGE_RATIO
• N_INTEREST_COVERAGE_RATIO

Request JSON Sample:

{"FSCARGO": {"LOCALE": "en-us","USER": "DEMOUSER","SERVICE_TYPE": "SEGMENTATION","OPERATION_TYPE": "ACCOUNT","ACTION_TYPE": "LOOKUP","REQUEST_NUMBER": 26,"PARAMS": [{"PARAM_CODE": "INFODOM","PARAM_VALUE": "OFSPFTINFO"},{"PARAM_CODE": "FOLDER","PARAM_VALUE": "PFTSEG"}],"PAYLOAD": {"PARTY": {"PARTY_ID": "RBIB1C16","PARTY_ATTRIBUTES": [],"ACCOUNTS": [{"ACCOUNT_NUMBER": "RBIB1C16A5","ACCOUNT_ATTRIBUTES": [{"ATTRIBUTE_NAME":"CUSTOMER_TYPE","ATTRIBUTE_VALUE":"R"},{"ATTRIBUTE_NAME":"SEGMENT_TYPE","ATTRIBUTE_VALUE":"BEH"},{"ATTRIBUTE_NAME":"V_PROD_CODE","ATTRIBUTE_VALUE":"9035"},{"ATTRIBUTE_NAME":"N_AGE","ATTRIBUTE_VALUE":"25"},{"ATTRIBUTE_NAME":"V_GENDER","ATTRIBUTE_VALUE":"M"},{"ATTRIBUTE_NAME":"V_MARITAL_STATUS","ATTRIBUTE_VALUE":"MSG"},{"ATTRIBUTE_NAME":"V_INDUSTRY","ATTRIBUTE_VALUE":"HELCA"},{"ATTRIBUTE_NAME":"V_COUNTRY","ATTRIBUTE_VALUE":"IN"},{"ATTRIBUTE_NAME":"N_INCOME","ATTRIBUTE_VALUE":"500000"}]}]},"EXEC_PARAMS": [{"PARAM_CODE": "AS_OF_DATE","PARAM_VALUE": "20200331"},{"PARAM_CODE": "RPT_CCY_CODE","PARAM_VALUE": "USD"}]}}}

Response JSON Sample:

A sample Web Service response JSON file (webservices_req_response.json) is available for reference.