openapi-directory/api/naviplancentral.com/plan.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"x-twitter":"AdvicentFP"},"description":"An API for accessing NaviPlan plan data for a client.","title":"Published Plan Service","version":"v1","x-apisguru-categories":["financial"],"x-logo":{"url":"https://twitter.com/AdvicentFP/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://demo.uat.naviplancentral.com/plan/swagger/docs/v1","version":"2.0"}],"x-providerName":"naviplancentral.com","x-serviceName":"plan"},"paths":{"/api/Advisors":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the Advisors in the plan.","operationId":"Advisors_Get","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.AdvisorsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.AdvisorsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for advisor details"},"404":{"description":"Object not found"}},"summary":"Retrieve Advisors","tags":["Advisors"]}},"/api/Advisors/{id}":{"get":{"deprecated":false,"description":"This operation retrieves an Advisor from the plan.","operationId":"Advisors_GetById","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.AdvisorModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.AdvisorModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for advisor details"},"404":{"description":"Object not found"}},"summary":"Retrieve an Advisor","tags":["Advisors"]}},"/api/Assumptions":{"get":{"deprecated":false,"description":"This operation retrieves an object containing all assumptions for the specified plan.","operationId":"Assumptions_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.AssumptionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.AssumptionsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve plan assumptions","tags":["Assumptions"]}},"/api/BusinessEntities":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the business entities in the plan.","operationId":"BusinessEntities_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.BusinessEntitiesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.BusinessEntitiesModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve business entities","tags":["BusinessEntities"]}},"/api/BusinessEntities/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a business entity from the plan.","operationId":"BusinessEntities_GetByIdPlanidScenariotype","parameters":[{"description":"ID of business entity to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.BusinessEntityModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.BusinessEntityModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a business entity","tags":["BusinessEntities"]}},"/api/Calculations/MonteCarlo":{"get":{"deprecated":false,"description":"Currently just stubbed out, POC in development","operationId":"Calculations_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve Monte Carlo results from standalone calc service","tags":["Calculations"]}},"/api/DefinedBenefitPensions":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the defined benefit pensions in the plan.","operationId":"DefinedBenefitPensions_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.DefinedBenefitPensionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.DefinedBenefitPensionsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve defined benefit pensions","tags":["DefinedBenefitPensions"]}},"/api/DefinedBenefitPensions/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a defined benefit pension from the plan.","operationId":"DefinedBenefitPensions_GetByIdPlanidScenariotype","parameters":[{"description":"ID of defined benefit pension to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.DefinedBenefitPensionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.DefinedBenefitPensionModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a definedBenefitPension","tags":["DefinedBenefitPensions"]}},"/api/Eula/Accept":{"post":{"deprecated":false,"operationId":"Eula_Accept","responses":{"200":{"description":"OK"},"500":{"description":"InternalServerError"}},"summary":"Accepts the EULA","tags":["Eula"]}},"/api/Family":{"get":{"deprecated":false,"description":"This operation retrieves an object containing all familymembers for the specified plan.","operationId":"Family_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.FamilyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.FamilyModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve family","tags":["Family"]}},"/api/GoalAdjustments/Education/{id}/Adjustments":{"get":{"deprecated":false,"description":"This function retrieves a goal and the adjustments made to it","operationId":"GoalAdjustments_GetEducationByIdClientidClientfileid","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The id of the client to retrieve adjustments for.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"The id of the client file to be operated on.","in":"query","name":"clientFileId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.EducationGoalAdjustmentsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.EducationGoalAdjustmentsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve the adjustments","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/Education/{id}/Calculations":{"post":{"deprecated":false,"description":"This function returns the posted object and the adjusted calculation values","operationId":"GoalAdjustments_PostEducationByIdGoaladjustments","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.GoalAdjustmentsModelEducationGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.GoalAdjustmentsModelEducationGoalAdjustments"}}},"description":"The original and adjusted values for this goal","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.CoverageProjectionsResultModelEducationGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.CoverageProjectionsResultModelEducationGoalAdjustments"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Perform calculations","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/GoalSuccessRates":{"get":{"deprecated":false,"operationId":"GoalAdjustments_GetGoalSuccessRatesByClientidClientfileid","parameters":[{"description":"The id of the client to retrieve adjustments for.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"The id of the client file to be operated on.","in":"query","name":"clientFileId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Goal Success Rates successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.GoalSuccessRateResultsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.GoalSuccessRateResultsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Returns a list of goals with their relevant success rates.","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/MajorPurchase/{id}/Adjustments":{"get":{"deprecated":false,"description":"This function retrieves a goal and the adjustments made to it","operationId":"GoalAdjustments_GetMajorPurchaseByIdClientidClientfileid","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The id of the client to retrieve adjustments for.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"The id of the client file to be operated on.","in":"query","name":"clientFileId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.MajorPurchaseGoalAdjustmentsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.MajorPurchaseGoalAdjustmentsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve the adjustments","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/MajorPurchase/{id}/Calculations":{"post":{"deprecated":false,"description":"This function returns the posted object and the adjusted calculation values","operationId":"GoalAdjustments_PostMajorPurchaseByIdGoaladjustments","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.GoalAdjustmentsModelMajorPurchaseGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.GoalAdjustmentsModelMajorPurchaseGoalAdjustments"}}},"description":"The original and adjusted values for this goal","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.CoverageProjectionsResultModelMajorPurchaseGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.CoverageProjectionsResultModelMajorPurchaseGoalAdjustments"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Perform calculations","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/Restrictions":{"get":{"deprecated":false,"description":"This function returns a list of adjustment restrictions for all goals.","operationId":"GoalAdjustments_GetGoalAdjustmentRestrictionsByClientidClientfileid","parameters":[{"description":"The id of the client user to act upon.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"The id of the client file to act upon.","in":"query","name":"clientFileId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Restrictions successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.RestrictionsResultModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.RestrictionsResultModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Returns a list of goal adjustment restrictions.","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/Retirement/{id}/Adjustments":{"get":{"deprecated":false,"description":"This function retrieves a goal and the adjustments made to it for a particular client","operationId":"GoalAdjustments_GetRetirementByIdClientidClientfileid","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The id of the client to retrieve adjustments for.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"The id of the client file to be operated on.","in":"query","name":"clientFileId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.RetirementGoalAdjustmentsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.RetirementGoalAdjustmentsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve the adjustments","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/Retirement/{id}/Calculations":{"post":{"deprecated":false,"description":"This function returns the posted object and the adjusted calculation values","operationId":"GoalAdjustments_PostRetirementByIdGoaladjustments","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.GoalAdjustmentsModelRetirementGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.GoalAdjustmentsModelRetirementGoalAdjustments"}}},"description":"The original and adjusted values for this goal","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.CoverageProjectionsResultModelRetirementGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.NaviPlanRestApiIntegrationProxy.Models.CoverageProjectionsResultModelRetirementGoalAdjustments"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Perform calculations","tags":["GoalAdjustments"]}},"/api/Goals":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the goals in the plan.","operationId":"Goals_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.GoalsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.GoalsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve goals","tags":["Goals"]}},"/api/Goals/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a goal from the plan.","operationId":"Goals_GetByIdPlanidScenariotype","parameters":[{"description":"ID of goal to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.GoalModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.GoalModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve goals","tags":["Goals"]}},"/api/HoldingCompanies":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the holding companies in the plan.","operationId":"HoldingCompanies_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.HoldingCompaniesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.HoldingCompaniesModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve holding companies","tags":["HoldingCompanies"]}},"/api/HoldingCompanies/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a holding company from the plan.","operationId":"HoldingCompanies_GetByIdPlanidScenariotype","parameters":[{"description":"ID of holding company to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.HoldingCompanyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.HoldingCompanyModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a holding company","tags":["HoldingCompanies"]}},"/api/Liabilities":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the liabilities in the plan.","operationId":"Liabilities_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.LiabilitiesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.LiabilitiesModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve liabilities","tags":["Liabilities"]}},"/api/Liabilities/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a liability from the plan.","operationId":"Liabilities_GetByIdPlanidScenariotype","parameters":[{"description":"ID of liability to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.LiabilityModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.LiabilityModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a liability","tags":["Liabilities"]}},"/api/LifestyleAssets":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the lifestyle assets in the plan.","operationId":"LifestyleAssets_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.LifestyleAssetsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.LifestyleAssetsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve lifestyle assets","tags":["LifestyleAssets"]}},"/api/LifestyleAssets/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a lifestyle asset from the plan.","operationId":"LifestyleAssets_GetByIdPlanidScenariotype","parameters":[{"description":"ID of lifestyle asset to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.LifestyleAssetModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.LifestyleAssetModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve lifestyle assets","tags":["LifestyleAssets"]}},"/api/NetWorth":{"get":{"deprecated":false,"description":"This operation retrieves an object containing net worth values for specific dates within the plan:\r\n              * Plan Start Date\r\n              * Retirement Date\r\n              * Plan End Date.","operationId":"NetWorth_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.NetWorthModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.NetWorthModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve net worth","tags":["NetWorth"]}},"/api/Password/HasUserSetPassword":{"post":{"deprecated":false,"operationId":"Password_HasUserSetPassword","responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"}},"summary":"Determines if the currently logged in user has set their own password","tags":["Password"]}},"/api/Password/PasswordRequirements":{"get":{"deprecated":false,"operationId":"Password_PasswordRequirements","responses":{"200":{"description":"OK"},"500":{"description":"InternalServerError"}},"summary":"Gets the password complexity requirements","tags":["Password"]}},"/api/Password/Reset":{"post":{"deprecated":false,"operationId":"Password_ResetByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Password.Models.ResetPasswordModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Password.Models.ResetPasswordModel"}}},"required":true},"responses":{"200":{"description":"OK"}},"summary":"Resets the password for the supplied user name","tags":["Password"]}},"/api/Password/Set":{"post":{"deprecated":false,"operationId":"Password_SetByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Password.Models.SetPasswordModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Password.Models.SetPasswordModel"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"}},"summary":"Sets the password for the currently logged in user","tags":["Password"]}},"/api/PlanInformation":{"get":{"deprecated":false,"description":"This operation retrieves the high level plan information for a given plan","operationId":"PlanInformation_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.PlanInformationModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.PlanInformationModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve plan information","tags":["PlanInformation"]}},"/api/PortfolioAccounts":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the portfolio accounts in the plan.","operationId":"PortfolioAccounts_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.PortfolioAccountsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.PortfolioAccountsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve portfolio accounts","tags":["PortfolioAccounts"]}},"/api/PortfolioAccounts/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a portfolio account from the plan.","operationId":"PortfolioAccounts_GetByIdPlanidScenariotype","parameters":[{"description":"ID of portfolio account to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.PortfolioAccountModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.PortfolioAccountModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a portfolio account","tags":["PortfolioAccounts"]}},"/api/ProjectedAnnualSummary":{"get":{"deprecated":false,"description":"This operation retrieves an object containing annual summary information \r\n              for each year of the projected plan.","operationId":"ProjectedAnnualSummary_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.ProjectedAnnualSummariesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.ProjectedAnnualSummariesModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected annual summaries","tags":["ProjectedAnnualSummary"]}},"/api/ProjectedAnnualSummary/{id}":{"get":{"deprecated":false,"description":"This operation retrieves an object containing annual summary information \r\n              for a single specified year of the projected plan.","operationId":"ProjectedAnnualSummary_GetByIdPlanidScenariotype","parameters":[{"description":"Index into the list of annual projections","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.ProjectedAnnualSummaryModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.ProjectedAnnualSummaryModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected annual summary by id","tags":["ProjectedAnnualSummary"]}},"/api/ProjectedCashFlow":{"get":{"deprecated":false,"description":"This operation retrieves an object containing cash flow information \r\n              for each year of the projected plan.","operationId":"ProjectedCashFlow_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.CashFlowProjectionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.CashFlowProjectionsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected cash flow","tags":["ProjectedCashFlow"]}},"/api/ProjectedCashFlow/{id}":{"get":{"deprecated":false,"description":"This operation retrieves an object containing cash flow information \r\n              for a single specified year of the projected plan.","operationId":"ProjectedCashFlow_GetByIdPlanidScenariotype","parameters":[{"description":"Index into the list of annual projections","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.CashFlowProjectionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.CashFlowProjectionModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected cash flow by id","tags":["ProjectedCashFlow"]}},"/api/ProjectedGoals/AssetsFundingGoals":{"get":{"deprecated":false,"description":"This operation retrieves the assets funding each goal throughout the plan years","operationId":"ProjectedGoals_GetAssetsFundingGoalsByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.AssetsFundingGoalModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.AssetsFundingGoalModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve assets funding goals over time","tags":["ProjectedGoals"]}},"/api/ProjectedGoals/NeedsVsAbilities":{"get":{"deprecated":false,"description":"This operation retrieves a needs and abilities data for all goals throughout\r\n              the plan years.","operationId":"ProjectedGoals_GetNeedsVsAbilitiesByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.NeedsVsAbilitiesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.NeedsVsAbilitiesModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve needs vs abilities data","tags":["ProjectedGoals"]}},"/api/ProjectedNetWorth":{"get":{"deprecated":false,"description":"This operation retrieves an object containing net worth information \r\n              for each year of the projected plan. These are EOY numbers.","operationId":"ProjectedNetWorth_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.NetWorthProjectionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.NetWorthProjectionsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected net worth","tags":["ProjectedNetWorth"]}},"/api/ProjectedNetWorth/{id}":{"get":{"deprecated":false,"description":"This operation retrieves an object containing net worth information \r\n              for a single specified year of the projected plan. These are EOY numbers.","operationId":"ProjectedNetWorth_GetByIdPlanidScenariotype","parameters":[{"description":"Index into the list of annual projections","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.NetWorthProjectionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.NetWorthProjectionModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected net worth by id","tags":["ProjectedNetWorth"]}},"/api/RestrictedStocks":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the restricted stocks in the plan.","operationId":"RestrictedStocks_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.RestrictedStocksModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.RestrictedStocksModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve restricted stocks","tags":["RestrictedStocks"]}},"/api/RestrictedStocks/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a restricted stock from the plan.","operationId":"RestrictedStocks_GetByIdPlanidScenariotype","parameters":[{"description":"ID of restricted stock to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.RestrictedStockModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.RestrictedStockModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a restricted stock","tags":["RestrictedStocks"]}},"/api/ServiceInformation/Statistics":{"get":{"deprecated":false,"operationId":"ServiceInformation_Statistics","responses":{"200":{"description":"Provides additional information about the service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.Altair.Common.ServiceInformation"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.Altair.Common.ServiceInformation"}}}}},"summary":"This resource can be used to check the status of the service.","tags":["ServiceInformation"]}},"/api/StockOptions":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the stock options in the plan.","operationId":"StockOptions_GetByPlanidScenariotype","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Type of plan to retrieve data from (0:Current-default, 1:Recommended)","in":"query","name":"scenarioType","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.StockOptionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.PublishedPlanService.Models.StockOptionsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve stock options","tags":["StockOptions"]}},"/api/StockOptions/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a stock option from the plan.","operationId":"StockOptions_GetByIdPlanidScenariotype","parameters":[{"description":"ID of stock option to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3). Default value is the first plan the user is authorized to access.","in":"query","name":"planId","required":false,"schema":{"type":"string"}},{"description":"Ty