POST api/RetirementFund

Request Information

URI Parameters

None.

Body Parameters

SI.Model.Simfund.Retirement.DTO.AdvancedSearchCriteria

Name	Type	Additional information
Predicates	Collection of SI.Model.Simfund.Retirement.DTO.SearchPredicate	None.
SortKeys	Collection of SI.Model.Simfund.Retirement.DTO.SortKey	None.
GroupKeys	Collection of SI.Model.Simfund.Retirement.DTO.SortKey	None.
StartAt	integer	None.
Take	integer	None.
ProductId	integer	None.
EntityName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Predicates": [
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Value": {},
      "IsOr": true,
      "Operator": 0,
      "ContainerId": 5,
      "IsLogicalContainer": true,
      "IgnoreSearchField": true
    },
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Value": {},
      "IsOr": true,
      "Operator": 0,
      "ContainerId": 5,
      "IsLogicalContainer": true,
      "IgnoreSearchField": true
    }
  ],
  "SortKeys": [
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    },
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    }
  ],
  "GroupKeys": [
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    },
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    }
  ],
  "StartAt": 1,
  "Take": 2,
  "ProductId": 3,
  "EntityName": "sample string 4"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SI.Model.Simfund.Retirement.DTO.Fund

Name	Type	Additional information
ResultCategoryId	integer	None.
FundId	string	None.
Name	string	None.
PortfolioName	string	None.
MorningstarCategory	string	None.
FundType	string	None.
Assets	decimal number	None.
PlanAssets	decimal number	None.
Ticker	string	None.
DefaultInvestmentOption	boolean	None.
Advisor	string	None.
SubAdvisor	string	None.
Manager	string	None.
MorningstarRating	string	None.
LipperClassification	string	None.
TotalCount	integer	None.
AssetComposition	SI.Model.Simfund.Retirement.DTO.InvestmentComposition	None.
TotalExpenseRatio	decimal number	None.
ManagementFee	decimal number	None.
Fee12b1	decimal number	None.
OtherFee	decimal number	None.
UnderlyingFee	decimal number	None.
PerformancePercentileM	decimal number	None.
IndexFund	boolean	None.
LifecycleRisk	boolean	None.
LifecycleTargetDate	boolean	None.
ETF	boolean	None.
FundOfFund	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ResultCategoryId": 1,
    "FundId": "sample string 2",
    "Name": "sample string 3",
    "PortfolioName": "sample string 4",
    "MorningstarCategory": "sample string 5",
    "FundType": "sample string 6",
    "Assets": 1.0,
    "PlanAssets": 1.0,
    "Ticker": "sample string 7",
    "DefaultInvestmentOption": true,
    "Advisor": "sample string 8",
    "SubAdvisor": "sample string 9",
    "Manager": "sample string 10",
    "MorningstarRating": "sample string 11",
    "LipperClassification": "sample string 12",
    "TotalCount": 13,
    "AssetComposition": {
      "Cash": 1.0,
      "USStock": 1.0,
      "NonUSStock": 1.0,
      "USBond": 1.0,
      "NonUSBond": 1.0,
      "Prefered": 1.0,
      "Convertible": 1.0,
      "Other": 1.0
    },
    "TotalExpenseRatio": 1.0,
    "ManagementFee": 1.0,
    "Fee12b1": 1.0,
    "OtherFee": 1.0,
    "UnderlyingFee": 1.0,
    "PerformancePercentileM": 1.0,
    "IndexFund": true,
    "LifecycleRisk": true,
    "LifecycleTargetDate": true,
    "ETF": true,
    "FundOfFund": true
  },
  {
    "ResultCategoryId": 1,
    "FundId": "sample string 2",
    "Name": "sample string 3",
    "PortfolioName": "sample string 4",
    "MorningstarCategory": "sample string 5",
    "FundType": "sample string 6",
    "Assets": 1.0,
    "PlanAssets": 1.0,
    "Ticker": "sample string 7",
    "DefaultInvestmentOption": true,
    "Advisor": "sample string 8",
    "SubAdvisor": "sample string 9",
    "Manager": "sample string 10",
    "MorningstarRating": "sample string 11",
    "LipperClassification": "sample string 12",
    "TotalCount": 13,
    "AssetComposition": {
      "Cash": 1.0,
      "USStock": 1.0,
      "NonUSStock": 1.0,
      "USBond": 1.0,
      "NonUSBond": 1.0,
      "Prefered": 1.0,
      "Convertible": 1.0,
      "Other": 1.0
    },
    "TotalExpenseRatio": 1.0,
    "ManagementFee": 1.0,
    "Fee12b1": 1.0,
    "OtherFee": 1.0,
    "UnderlyingFee": 1.0,
    "PerformancePercentileM": 1.0,
    "IndexFund": true,
    "LifecycleRisk": true,
    "LifecycleTargetDate": true,
    "ETF": true,
    "FundOfFund": true
  }
]