6 Segment Averages (Specific)

Endpoint (HTTP Link): http://<hostname>:<port>/rest-v1/segmentAverages/

Service Type: POST

Query Prameters: Not applicable

Request Parameters:

  • portfolio_code

    String

    Refers to the Code for the portfolio: Portfolio being that of Retail or Institutional.

  • segment_type_code

    String

    Refers to the Code for Segment Type : Segment Type being Demographic/ Risk Based/ Profitability/ Behavioral, and so on.

  • segment_code

    String

    Refers to the Code for Segment within a particular Segment Type.

  • product_code

    String

    Refers to the Code assigned to a Product.

  • replines
    • replineCode

      String

      Refers to the Code assigned to a Reporting Line.

Request JSON Sample:
{"portfolio_code": "string","segment_type_code": "string","segment_code": "string","product_code": "string","replines": [{"replineCode": "string"}]}

Response Parameters:

  • portfolio_code

    String

    Refers to the Code for the portfolio: Portfolio being that of Retail or Institutional.

  • portfolio_name

    String

    Refers to the Name for the portfolio: Portfolio being that of Retail or Institutional.

  • segment_type_code

    String

    Refers to the Code for Segment Type : Segment Type being Demographic/Risk Based/Profitability/Behavioral, and so on.

  • segment_type_name

    String

    Refers to the Name for Segment Type: Segment Type being Demographic/Risk Based/Profitability/Behavioral, and so on.

  • segment_code

    String

    Refers to the Code for Segment within a particular Segment Type.

  • product_code

    String

    Refers to the Code assigned to a Product.

  • product_name

    String

    Refers to Name of Banking Product.

  • language_code

    String

    Code Indicating Language.

  • replines
    • repline_code

      String

      Refers to the Code assigned to a Reporting Line.

    • repline_name

      String

      Refers to the Name assigned to a Reporting Line.

    • repline_category

      String

      Refers to whether the Reporting Line is holding Amount field or a Balance field.

    • currency_code

      String

      Code Indicating the Base Currency.

    • month_on_book

      Number

      Refers to the Age of the Account on Banking books.

    • repline_value

      Number

      Value of the field corresponding to the Reporting line.

Response JSON Sample:
{"items": [{"portfolio_code": "string","portfolio_name": "string","segment_type_code": "string","segment_type_name": "string","segment_code": "string","segment_name": "string","product_code": "string","product_name": "string","language_code": "string","replines": [{"repline_code": "string","repline_name": "string","repline_category": "string","currency_code": "string","month_on_book": 0,"repline_value": 0}]}]}