chatbot
clear chat
Skip to main content

Diagnostic results query

GET 
/results/:scenarioId/query/diagnostics/goal/:goalId

Retrieves the extracted data results for the given diagnostics. The diagnosticTypes request param includes all the diagnostics runs in the payload of the trigger diagnose goal as comma separated values.

Request​

Path Parameters

    scenarioId stringrequired

    The scenario's id

    goalId stringrequired

    The goal's id

Query Parameters

    diagnosticTypes string[]required

    Possible values: [EXPENSE_LIVING_EXPENSES_DECREASE, EXPENSE_RENT_VS_MORTGAGE_ON_RESIDENTIAL_PROPERTY, EXPENSE_MORTGAGE_ON_RESIDENTIAL_PROPERTY_VS_RENT, INCOME_EARNED_INCOME_INCREASE_PRIMARY, INCOME_EARNED_INCOME_INCREASE_PARTNER, INCOME_WORK_PART_TIME_AFTER_RETIREMENT_PRIMARY, INCOME_WORK_PART_TIME_AFTER_RETIREMENT_PARTNER, GOAL_SWITCH_OFF_EARLIER_GOALS, GOAL_SPEND_LESS_MONEY_ON_GOAL, GOAL_MOVE_IT_TO_THE_FUTURE, GOAL_BUY_A_HOUSE_DOWNPAYMENT, GOAL_BUY_A_HOUSE_MORTGAGE_AFFORDABILITY, GOAL_BORROW, GOAL_SAVE_IN_YEARS, PROPERTY_MOVE_TO_SMALLER_PROPERTY, PROPERTY_SELL_BUY_TO_LET_PROPERTIES, DEBT_RESIDENTIAL_PROPERTIES_REMORTGAGE, DEBT_INVESTMENT_PROPERTIES_REMORTGAGE, DEBT_ELIMINATE_DEBT, WRAPPER_TAX_ADVANTAGED_RISK_INCREASE_PRIMARY, WRAPPER_TAX_ADVANTAGED_RISK_INCREASE_PARTNER, WRAPPER_TAX_ADVANTAGED_RISK_DECREASE_PRIMARY, WRAPPER_TAX_ADVANTAGED_RISK_DECREASE_PARTNER, WRAPPER_GIA_RISK_INCREASE_PRIMARY, WRAPPER_GIA_RISK_INCREASE_PARTNER, WRAPPER_GIA_RISK_DECREASE_PRIMARY, WRAPPER_GIA_RISK_DECREASE_PARTNER, WRAPPER_PENSION_RISK_INCREASE_PRIMARY, WRAPPER_PENSION_RISK_INCREASE_PARTNER, WRAPPER_PENSION_RISK_DECREASE_PRIMARY, WRAPPER_PENSION_RISK_DECREASE_PARTNER, WRAPPER_PENSION_CONTRIBUTION_INCREASE_PRIMARY, WRAPPER_PENSION_CONTRIBUTION_INCREASE_PARTNER, SAVINGS_TAX_ADVANTAGED_INVESTMENTS_ENABLE_PRIMARY, SAVINGS_TAX_ADVANTAGED_INVESTMENTS_ENABLE_PARTNER, SAVINGS_GIA_INVESTMENTS_ENABLE_PRIMARY, SAVINGS_GIA_INVESTMENTS_ENABLE_PARTNER, INSURANCE_TERM_LIFE_INSURANCE_INCREASE_PRIMARY, INSURANCE_TERM_LIFE_INSURANCE_INCREASE_PARTNER, INSURANCE_DISABILITY_INSURANCE_INCREASE_PRIMARY, INSURANCE_DISABILITY_INSURANCE_INCREASE_PARTNER, INSURANCE_CRITICAL_ILLNESS_INSURANCE_INCREASE_PRIMARY, INSURANCE_CRITICAL_ILLNESS_INSURANCE_INCREASE_PARTNER, INSURANCE_MORTGAGE_LIFE_INSURANCE_INCREASE, LIFESTYLE_TOO_UNHEALTHY_PRIMARY, LIFESTYLE_TOO_UNHEALTHY_PARTNER, NONE]

    List of diagnostic types

    page integer

    Zero-based page index (0..N)

    size integer

    Default value: 20

    The size of the page to be returned

    sort string[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses​

OK

Schema
    content object[]
  • Array [
    • clientId stringrequired
    description string
    diagnosticType stringrequired

    Possible values: [EXPENSE_LIVING_EXPENSES_DECREASE, EXPENSE_RENT_VS_MORTGAGE_ON_RESIDENTIAL_PROPERTY, EXPENSE_MORTGAGE_ON_RESIDENTIAL_PROPERTY_VS_RENT, INCOME_EARNED_INCOME_INCREASE_PRIMARY, INCOME_EARNED_INCOME_INCREASE_PARTNER, INCOME_WORK_PART_TIME_AFTER_RETIREMENT_PRIMARY, INCOME_WORK_PART_TIME_AFTER_RETIREMENT_PARTNER, GOAL_SWITCH_OFF_EARLIER_GOALS, GOAL_SPEND_LESS_MONEY_ON_GOAL, GOAL_MOVE_IT_TO_THE_FUTURE, GOAL_BUY_A_HOUSE_DOWNPAYMENT, GOAL_BUY_A_HOUSE_MORTGAGE_AFFORDABILITY, GOAL_BORROW, GOAL_SAVE_IN_YEARS, PROPERTY_MOVE_TO_SMALLER_PROPERTY, PROPERTY_SELL_BUY_TO_LET_PROPERTIES, DEBT_RESIDENTIAL_PROPERTIES_REMORTGAGE, DEBT_INVESTMENT_PROPERTIES_REMORTGAGE, DEBT_ELIMINATE_DEBT, WRAPPER_TAX_ADVANTAGED_RISK_INCREASE_PRIMARY, WRAPPER_TAX_ADVANTAGED_RISK_INCREASE_PARTNER, WRAPPER_TAX_ADVANTAGED_RISK_DECREASE_PRIMARY, WRAPPER_TAX_ADVANTAGED_RISK_DECREASE_PARTNER, WRAPPER_GIA_RISK_INCREASE_PRIMARY, WRAPPER_GIA_RISK_INCREASE_PARTNER, WRAPPER_GIA_RISK_DECREASE_PRIMARY, WRAPPER_GIA_RISK_DECREASE_PARTNER, WRAPPER_PENSION_RISK_INCREASE_PRIMARY, WRAPPER_PENSION_RISK_INCREASE_PARTNER, WRAPPER_PENSION_RISK_DECREASE_PRIMARY, WRAPPER_PENSION_RISK_DECREASE_PARTNER, WRAPPER_PENSION_CONTRIBUTION_INCREASE_PRIMARY, WRAPPER_PENSION_CONTRIBUTION_INCREASE_PARTNER, SAVINGS_TAX_ADVANTAGED_INVESTMENTS_ENABLE_PRIMARY, SAVINGS_TAX_ADVANTAGED_INVESTMENTS_ENABLE_PARTNER, SAVINGS_GIA_INVESTMENTS_ENABLE_PRIMARY, SAVINGS_GIA_INVESTMENTS_ENABLE_PARTNER, INSURANCE_TERM_LIFE_INSURANCE_INCREASE_PRIMARY, INSURANCE_TERM_LIFE_INSURANCE_INCREASE_PARTNER, INSURANCE_DISABILITY_INSURANCE_INCREASE_PRIMARY, INSURANCE_DISABILITY_INSURANCE_INCREASE_PARTNER, INSURANCE_CRITICAL_ILLNESS_INSURANCE_INCREASE_PRIMARY, INSURANCE_CRITICAL_ILLNESS_INSURANCE_INCREASE_PARTNER, INSURANCE_MORTGAGE_LIFE_INSURANCE_INCREASE, LIFESTYLE_TOO_UNHEALTHY_PRIMARY, LIFESTYLE_TOO_UNHEALTHY_PARTNER, NONE]

    goalId stringrequired
    id string
    name string
    results object[]required
  • Array [
    • name string
    results object[]
  • Array [
    • data object
    property name* object
    goalId string
    lifeId int32
    timestepId int32
  • ]
  • ]
    • scenarioId stringrequired
    simulationId string
    username string
  • ]
    • empty boolean
    first boolean
    last boolean
    number int32
    numberOfElements int32
    pageable object
    offset int64
    pageNumber int32
    pageSize int32
    paged boolean
    sort object
    empty boolean
    sorted boolean
    unsorted boolean
    unpaged boolean
    size int32
    sort object
    empty boolean
    sorted boolean
    unsorted boolean
    totalElements int64
    totalPages int32
Loading...