POST api/RetirementPlan

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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'SI.Model.Simfund.Retirement.DTO.AdvancedSearchCriteria'.

Response Information

Resource Description

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

Name	Type	Additional information
ResultCategoryId	integer	None.
PlanId	string	None.
Name	string	None.
PlanType	string	None.
Assets	decimal number	None.
Fees	decimal number	None.
ActiveParticipants	decimal number	None.
TotalParticipants	decimal number	None.
ParticipationRate	decimal number	None.
Industry	string	None.
Recordkeeper	string	None.
TotalCount	integer	None.
AssetsMutualFund	decimal number	None.
PercentageMutualFund	decimal number	None.
AssetsCollectiveTrust	decimal number	None.
PercentageCollectiveTrust	decimal number	None.
AssetsSeparateAccount	decimal number	None.
PercentageSeparateAccount	decimal number	None.
PlanFundAssets	decimal number	None.
Sponsor	SI.Model.Simfund.Retirement.DTO.PlanServiceProvider	None.
Advisor	SI.Model.Simfund.Retirement.DTO.PlanServiceProvider	None.
Investments	Collection of SI.Model.Simfund.Retirement.DTO.Fund	None.
InvestmentVehicles	Collection of SI.Model.Simfund.Retirement.DTO.InvestmentVehicle	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ResultCategoryId": 1,
    "PlanId": "sample string 2",
    "Name": "sample string 3",
    "PlanType": "sample string 4",
    "Assets": 1.0,
    "Fees": 1.0,
    "ActiveParticipants": 1.0,
    "TotalParticipants": 1.0,
    "ParticipationRate": 1.1,
    "Industry": "sample string 5",
    "Recordkeeper": "sample string 6",
    "TotalCount": 7,
    "AssetsMutualFund": 1.1,
    "PercentageMutualFund": 1.1,
    "AssetsCollectiveTrust": 1.1,
    "PercentageCollectiveTrust": 1.1,
    "AssetsSeparateAccount": 1.1,
    "PercentageSeparateAccount": 1.1,
    "PlanFundAssets": 1.1,
    "Sponsor": {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "ZipCode": "sample string 5",
      "County": "sample string 6",
      "ContactName": "sample string 7",
      "Phone": "sample string 8",
      "Latitude": {},
      "Longitude": {},
      "Distance": 1.1
    },
    "Advisor": {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "ZipCode": "sample string 5",
      "County": "sample string 6",
      "ContactName": "sample string 7",
      "Phone": "sample string 8",
      "Latitude": {},
      "Longitude": {},
      "Distance": 1.1
    },
    "Investments": [
      {
        "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
      }
    ],
    "InvestmentVehicles": [
      {
        "InvestmentVehicleId": "sample string 1",
        "InvestmentVehicleName": "sample string 2",
        "InvestmentVehicleFamily": "sample string 3",
        "InvestmentVehicleType": "sample string 4",
        "SimfundMFFund": true,
        "PlanAssets": 1.1,
        "TotalReturn3Y": 1.0,
        "CategoryReturnPercentile3Y": 1.0,
        "MorningstarRating3Y": "sample string 6",
        "MorningstarCategory": "sample string 7"
      },
      {
        "InvestmentVehicleId": "sample string 1",
        "InvestmentVehicleName": "sample string 2",
        "InvestmentVehicleFamily": "sample string 3",
        "InvestmentVehicleType": "sample string 4",
        "SimfundMFFund": true,
        "PlanAssets": 1.1,
        "TotalReturn3Y": 1.0,
        "CategoryReturnPercentile3Y": 1.0,
        "MorningstarRating3Y": "sample string 6",
        "MorningstarCategory": "sample string 7"
      }
    ]
  },
  {
    "ResultCategoryId": 1,
    "PlanId": "sample string 2",
    "Name": "sample string 3",
    "PlanType": "sample string 4",
    "Assets": 1.0,
    "Fees": 1.0,
    "ActiveParticipants": 1.0,
    "TotalParticipants": 1.0,
    "ParticipationRate": 1.1,
    "Industry": "sample string 5",
    "Recordkeeper": "sample string 6",
    "TotalCount": 7,
    "AssetsMutualFund": 1.1,
    "PercentageMutualFund": 1.1,
    "AssetsCollectiveTrust": 1.1,
    "PercentageCollectiveTrust": 1.1,
    "AssetsSeparateAccount": 1.1,
    "PercentageSeparateAccount": 1.1,
    "PlanFundAssets": 1.1,
    "Sponsor": {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "ZipCode": "sample string 5",
      "County": "sample string 6",
      "ContactName": "sample string 7",
      "Phone": "sample string 8",
      "Latitude": {},
      "Longitude": {},
      "Distance": 1.1
    },
    "Advisor": {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "ZipCode": "sample string 5",
      "County": "sample string 6",
      "ContactName": "sample string 7",
      "Phone": "sample string 8",
      "Latitude": {},
      "Longitude": {},
      "Distance": 1.1
    },
    "Investments": [
      {
        "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
      }
    ],
    "InvestmentVehicles": [
      {
        "InvestmentVehicleId": "sample string 1",
        "InvestmentVehicleName": "sample string 2",
        "InvestmentVehicleFamily": "sample string 3",
        "InvestmentVehicleType": "sample string 4",
        "SimfundMFFund": true,
        "PlanAssets": 1.1,
        "TotalReturn3Y": 1.0,
        "CategoryReturnPercentile3Y": 1.0,
        "MorningstarRating3Y": "sample string 6",
        "MorningstarCategory": "sample string 7"
      },
      {
        "InvestmentVehicleId": "sample string 1",
        "InvestmentVehicleName": "sample string 2",
        "InvestmentVehicleFamily": "sample string 3",
        "InvestmentVehicleType": "sample string 4",
        "SimfundMFFund": true,
        "PlanAssets": 1.1,
        "TotalReturn3Y": 1.0,
        "CategoryReturnPercentile3Y": 1.0,
        "MorningstarRating3Y": "sample string 6",
        "MorningstarCategory": "sample string 7"
      }
    ]
  }
]