openapi-directory

Version:

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

github.com/httptoolkit/openapi-directory-js

1 lines • 201 kB

JSON

{"openapi":"3.0.0","info":{"contact":{"x-twitter":"AdvicentFP"},"description":"An API for accessing the Narrator Fact Finder.","title":"Advicent.FactFinderService","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/factfinder/swagger/docs/v1","version":"2.0"}],"x-providerName":"naviplancentral.com","x-serviceName":"factfinder"},"paths":{"/api/AccountTypes":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Account Types for the specified country. \r\n Purpose: Provides access to the Account Types including id and type description.","operationId":"AccountTypes_GetByCountry","parameters":[{"description":"The country used to filter Account Types","in":"query","name":"country","required":true,"schema":{"type":"string","enum":["UnitedStates","Canada"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountTypesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountTypesModel"}}}},"400":{"description":"The request is invalid."},"404":{"description":"Account Type not found."}},"tags":["AccountTypes"]}},"/api/AccountTypes/{id}":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Account Types for the specified id. \r\n Purpose: Provides access to the Account Types including id and type description.","operationId":"AccountTypes_GetById","parameters":[{"description":"The ID of Account Type used to retreive the Account Type information","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountTypeModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountTypeModel"}}}},"400":{"description":"The request is invalid."},"404":{"description":"Account Type not found."}},"tags":["AccountTypes"]}},"/api/Accounts":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Accounts for the specified Fact Finder ID and/or external source ID. \r\n Purpose: Provides access to the Account information including description and market value.","operationId":"Accounts_GetAccountsByFactFinderIdByFactfinderidExternalsourceid","parameters":[{"description":"The ID of the Fact Finder used to retrieve Accounts","in":"query","name":"factFinderId","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The external ID used to filter Accounts","in":"query","name":"externalSourceId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountsModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Account."},"403":{"description":"Request is restricted for access to Account."},"404":{"description":"Account not found."}},"tags":["Accounts"]},"post":{"deprecated":false,"description":"Description: The operation creates an Account. \r\n Purpose: Allows for creation of Accounts on a Fact Finder.","operationId":"Accounts_PostByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountModel"}}},"description":"The Account to be added to the Fact Finder","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Account."},"403":{"description":"Request is restricted for access to Account."},"404":{"description":"Account not found."}},"tags":["Accounts"]}},"/api/Accounts/{accountId}/Holdings/{id}":{"get":{"deprecated":false,"description":"Description: This operation retrieves a single Account Holding for the specified Account Holding ID and Account ID. \r\n Purpose: Provides access to the Account Holding information including description and market value.","operationId":"Accounts_GetAccountHoldingByAccountidId","parameters":[{"description":"The ID of the Account used to retreive the Account Holding data","in":"path","name":"accountId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The ID of the Account Holding used to retreive the Account Holding data","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountHoldingWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountHoldingWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Account."},"403":{"description":"Request is restricted for access to Account."},"404":{"description":"Account not found."}},"tags":["Accounts"]}},"/api/Accounts/{id}":{"delete":{"deprecated":false,"description":"Description: The operation removes an Account tied to a Fact Finder. \r\n Purpose: Allows for removal of an Account from a Fact Finder.","operationId":"Accounts_DeleteAccountById","parameters":[{"description":"The Account ID used to identify which Account to remove","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Account."},"403":{"description":"Request is restricted for access to Account."},"404":{"description":"Account not found."}},"tags":["Accounts"]},"get":{"deprecated":false,"description":"Description: This operation retrieves a single Account for the specified Account ID. \r\n Purpose: Provides access to the Account information including description and market value.","operationId":"Accounts_GetById","parameters":[{"description":"The ID of the Account used to retreive the Account data","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Account."},"403":{"description":"Request is restricted for access to Account."},"404":{"description":"Account not found."}},"tags":["Accounts"]},"put":{"deprecated":false,"description":"Description: The operation updates an Account. \r\n Purpose: Allows for complete replacement of an Account on a Fact Finder.","operationId":"Accounts_PutByIdModel","parameters":[{"description":"The existing Account ID used to identify which Account to update","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountModel"}}},"description":"The Account to be updated on a Fact Finder","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.AccountWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Account."},"403":{"description":"Request is restricted for access to Account."},"404":{"description":"Account not found."}},"tags":["Accounts"]}},"/api/Clients":{"post":{"deprecated":false,"description":"Description: This operation submits the Fact Finder data to an external system. \r\n Purpose: Allows Fact Finder data to be persisted in another system for that system's consumption and use.","operationId":"Clients_PostByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.ClientsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.ClientsModel"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.ClientModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.ClientModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Client."},"403":{"description":"Request is restricted for access to Client."}},"tags":["Clients"]}},"/api/CriticalIllnessInsurancePolicies":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Critical Illness Insurance Policies for the specified Fact Finder ID. \r\n Purpose: Provides access to the Critical Illness Insurance Policies including description and policy type.","operationId":"CriticalIllnessInsurancePolicies_GetCriticalIllnessInsurancePoliciesByFactFinderIdByFactfinderid","parameters":[{"description":"The ID of the Fact Finder used to retrieve Critical Illness Insurance Policies","in":"query","name":"factFinderId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePoliciesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePoliciesModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Critical Illness Insurance Policy."},"403":{"description":"Request is restricted for access to Critical Illness Insurance Policy."},"404":{"description":"Critical Illness Insurance Policy not found."}},"tags":["CriticalIllnessInsurancePolicies"]},"post":{"deprecated":false,"description":"Description: The operation creates a Critical Illness Insurance Policy. \r\n Purpose: Allows for creation of Critical Illness Insurance Policies on a Fact Finder.","operationId":"CriticalIllnessInsurancePolicies_PostByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyModel"}}},"description":"The Critical Illness Insurance Policy to be added to the Fact Finder","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Critical Illness Insurance Policy."},"403":{"description":"Request is restricted for access to Critical Illness Insurance Policy."},"404":{"description":"Critical Illness Insurance Policy not found."}},"tags":["CriticalIllnessInsurancePolicies"]}},"/api/CriticalIllnessInsurancePolicies/{id}":{"delete":{"deprecated":false,"description":"Description: The operation removes a Critical Illness Insurance Policy tied to a Fact Finder. \r\n Purpose: Allows for removal of a Critical Illness Insurance Policy from a Fact Finder.","operationId":"CriticalIllnessInsurancePolicies_DeleteById","parameters":[{"description":"The Critical Illness Insurance Policy ID used to identify which Critical Illness Insurance Policy to remove","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Critical Illness Insurance Policy."},"403":{"description":"Request is restricted for access to Critical Illness Insurance Policy."},"404":{"description":"Critical Illness Insurance Policy not found."}},"tags":["CriticalIllnessInsurancePolicies"]},"get":{"deprecated":false,"description":"Description: This operation retrieves a single Critical Illness Insurance Policy for the specified Critical Illness Insurance Policy ID. \r\n Purpose: Provides access to the Critical Illness Insurance Policy including description and policy type.","operationId":"CriticalIllnessInsurancePolicies_GetById","parameters":[{"description":"The ID of the Critical Illness Insurance Policy used to retreive the Critical Illness Insurance Policy","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Critical Illness Insurance Policy."},"403":{"description":"Request is restricted for access to Critical Illness Insurance Policy."},"404":{"description":"Critical Illness Insurance Policy not found."}},"tags":["CriticalIllnessInsurancePolicies"]},"put":{"deprecated":false,"description":"Description: The operation updates a Critical Illness Insurance Policy. \r\n Purpose: Allows for complete replacement of a Critical Illness Insurance Policy on a Fact Finder.","operationId":"CriticalIllnessInsurancePolicies_PutByIdModel","parameters":[{"description":"The existing Critical Illness Insurance Policy ID used to identify which Critical Illness Insurance Policy to update","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyModel"}}},"description":"The Critical Illness Insurance Policy to be updated on a Fact Finder","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Critical Illness Insurance Policy."},"403":{"description":"Request is restricted for access to Critical Illness Insurance Policy."},"404":{"description":"Critical Illness Insurance Policy not found."}},"tags":["CriticalIllnessInsurancePolicies"]}},"/api/CriticalIllnessInsurancePolicyTypes":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Critical Illness Insurance Policy Types for the specified country. \r\n Purpose: Provides access to the Critical Illness Insurance Policy Types including id and type description.","operationId":"CriticalIllnessInsurancePolicyTypes_GetByCountry","parameters":[{"description":"The country used to filter Critical Illness Insurance Policy Types","in":"query","name":"country","required":true,"schema":{"type":"string","enum":["UnitedStates","Canada"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyTypesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyTypesModel"}}}},"400":{"description":"The request is invalid."},"404":{"description":"Critical Illness Insurance Policy Type not found."}},"tags":["CriticalIllnessInsurancePolicyTypes"]}},"/api/CriticalIllnessInsurancePolicyTypes/{id}":{"get":{"deprecated":false,"description":"Description: This operation retrieves the Critical Illness Insurance Policy Type for the specified id. \r\n Purpose: Provides access to the Critical Illness Insurance Policy Types including id and type description.","operationId":"CriticalIllnessInsurancePolicyTypes_GetById","parameters":[{"description":"The ID of Critical Illness Insurance Policy Type used to retreive the Critical Illness Insurance Policy Type information","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyTypeModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.CriticalIllnessInsurancePolicyTypeModel"}}}},"400":{"description":"The request is invalid."},"404":{"description":"Critical Illness Insurance Policy Type not found."}},"tags":["CriticalIllnessInsurancePolicyTypes"]}},"/api/DefinedBenefitPensions":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Defined Benefit Pensions for the specified Fact Finder ID. \r\n Purpose: Provides access to the Defined Benefit Pensions including description and start date.","operationId":"DefinedBenefitPensions_GetDefinedBenefitPensionsByFactFinderIdByFactfinderid","parameters":[{"description":"The ID of the Fact Finder used to retrieve Defined Benefit Pensions","in":"query","name":"factFinderId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionsModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Defined Benefit Pension."},"403":{"description":"Request is restricted for access to Defined Benefit Pension."},"404":{"description":"Defined Benefit Pension not found."}},"tags":["DefinedBenefitPensions"]},"post":{"deprecated":false,"description":"Description: The operation creates a Defined Benefit Pension. \r\n Purpose: Allows for creation of Defined Benefit Pensions on a Fact Finder.","operationId":"DefinedBenefitPensions_PostByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionModel"}}},"description":"The Defined Benefit Pension to be added to the Fact Finder","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/System.Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/System.Object"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Defined Benefit Pension."},"403":{"description":"Request is restricted for access to Defined Benefit Pension."},"404":{"description":"Defined Benefit Pension not found."}},"tags":["DefinedBenefitPensions"]}},"/api/DefinedBenefitPensions/{id}":{"delete":{"deprecated":false,"description":"Description: The operation removes a Defined Benefit Pension tied to a Fact Finder. \r\n Purpose: Allows for removal of a Defined Benefit Pension from a Fact Finder.","operationId":"DefinedBenefitPensions_DeleteDefinedBenefitPensionById","parameters":[{"description":"The Defined Benefit Pension ID used to identify which Defined Benefit Pension to remove","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/System.Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/System.Object"}}}},"204":{"description":"Deleted"},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Defined Benefit Pension."},"403":{"description":"Request is restricted for access to Defined Benefit Pension."},"404":{"description":"Defined Benefit Pension not found."}},"tags":["DefinedBenefitPensions"]},"get":{"deprecated":false,"description":"Description: This operation retrieves a single Defined Benefit Pension for the specified Defined Benefit Pension ID. \r\n Purpose: Provides access to the Defined Benefit Pension including description and start date.","operationId":"DefinedBenefitPensions_GetById","parameters":[{"description":"The ID of the Defined Benefit Pension used to retreive the Defined Benefit Pension","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Defined Benefit Pension."},"403":{"description":"Request is restricted for access to Defined Benefit Pension."},"404":{"description":"Defined Benefit Pension not found."}},"tags":["DefinedBenefitPensions"]},"put":{"deprecated":false,"description":"Description: The operation updates a Defined Benefit Pension. \r\n Purpose: Allows for complete replacement of a Defined Benefit Pension on a Fact Finder.","operationId":"DefinedBenefitPensions_PutDefinedBenefitPensionByIdModel","parameters":[{"description":"The existing Defined Benefit Pension ID used to identify which Defined Benefit Pension to update","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionModel"}}},"description":"The Defined Benefit Pension to be updated on a Fact Finder","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DefinedBenefitPensionModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Defined Benefit Pension."},"403":{"description":"Request is restricted for access to Defined Benefit Pension."},"404":{"description":"Defined Benefit Pension not found."}},"tags":["DefinedBenefitPensions"]}},"/api/Demographics":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Demographic information for the specified Fact Finder ID. \r\n Purpose: Provides access to the Demographic information including city and state.","operationId":"Demographics_GetDemographicsByFactFinderIdByFactfinderid","parameters":[{"description":"The ID of the Fact Finder used to retrieve Demographic information","in":"query","name":"factFinderId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Demographic information."},"403":{"description":"Request is restricted for access to Demographic information."},"404":{"description":"Demographic information not found."}},"tags":["Demographics"]},"post":{"deprecated":false,"description":"Description: The operation creates Demographic information. \r\n Purpose: Allows for creation of Demographic information on a Fact Finder.","operationId":"Demographics_PostByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsModel"}}},"description":"The Demographic information to be added to the Fact Finder","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Demographic information."},"403":{"description":"Request is restricted for access to Demographic information."},"404":{"description":"Demographic information not found."}},"tags":["Demographics"]}},"/api/Demographics/{demographicId}/Dependents":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Dependents for the specified Demographic information ID. \r\n Purpose: Provides access to the Dependents including first and last name.","operationId":"Demographics_GetDependentsByDemographicid","parameters":[{"description":"The ID of the Demographic information used to retrieve Dependents","in":"path","name":"demographicId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentsModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Dependent information."},"403":{"description":"Request is restricted for access to Dependent information."},"404":{"description":"Dependent information not found."}},"tags":["Demographics"]},"post":{"deprecated":false,"description":"Description: The operation creates a Dependent. \r\n Purpose: Allows for creation of Dependents on a Fact Finder.","operationId":"Demographics_PostByDemographicidModel","parameters":[{"description":"The ID of the Demographic information to add the Dependent to","in":"path","name":"demographicId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentModel"}}},"description":"The Dependent to be added to the Fact Finder","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Dependent information."},"403":{"description":"Request is restricted for access to Dependent information."},"404":{"description":"Dependent information not found."},"409":{"description":"The request cannot be completed."}},"tags":["Demographics"]}},"/api/Demographics/{demographicId}/Dependents/{id}":{"delete":{"deprecated":false,"description":"Description: The operation removes a Dependent tied to a Fact Finder. \r\n Purpose: Allows for removal of a Dependent from a Fact Finder.","operationId":"Demographics_DeleteDependentByDemographicidId","parameters":[{"description":"The ID of the Demographic information used to identify which Dependent to remove","in":"path","name":"demographicId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The Dependent ID used to identify which Dependent to remove","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Dependent information."},"403":{"description":"Request is restricted for access to Dependent information."},"404":{"description":"Dependent information not found."}},"tags":["Demographics"]},"get":{"deprecated":false,"description":"Description: This operation retrieves a single Dependent for the specified Dependent ID. \r\n Purpose: Provides access to the Dependent including first and last name.","operationId":"Demographics_GetDependentByDemographicidId","parameters":[{"description":"The ID of the Demographic information used to retrieve Dependents","in":"path","name":"demographicId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The ID of the Dependent used to retreive the Dependent","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Dependent information."},"403":{"description":"Request is restricted for access to Dependent information."},"404":{"description":"Dependent information not found."}},"tags":["Demographics"]},"put":{"deprecated":false,"description":"Description: The operation updates a Dependent. \r\n Purpose: Allows for complete replacement of a Dependent on a Fact Finder.","operationId":"Demographics_PutByDemographicidIdModel","parameters":[{"description":"The ID of the Demographic information used to identify which Dependent to update","in":"path","name":"demographicId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The existing Dependent ID used to identify which Dependent to update","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentModel"}}},"description":"The Dependent to be updated on a Fact Finder","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsDependentWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Dependent information."},"403":{"description":"Request is restricted for access to Dependent information."},"404":{"description":"Dependent information not found."}},"tags":["Demographics"]}},"/api/Demographics/{id}":{"get":{"deprecated":false,"description":"Description: This operation retrieves Demographic information for the specified Demographic information ID. \r\n Purpose: Provides access to the Demographic information including city and state.","operationId":"Demographics_GetById","parameters":[{"description":"The ID of the Demographic information used to retreive the Demographic information","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Demographic information."},"403":{"description":"Request is restricted for access to Demographic information."},"404":{"description":"Demographic information not found."}},"tags":["Demographics"]},"put":{"deprecated":false,"description":"Description: The operation updates Demographic information. \r\n Purpose: Allows for complete replacement of Demographic information on a Fact Finder.","operationId":"Demographics_PutByIdModel","parameters":[{"description":"The existing Demographic information ID used to identify which Demographic information to update","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsModel"}}},"description":"The Demographic information to be updated on a Fact Finder","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DemographicsWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Demographic information."},"403":{"description":"Request is restricted for access to Demographic information."},"404":{"description":"Demographic information not found."},"409":{"description":"The request cannot be completed."}},"tags":["Demographics"]}},"/api/DisabilityInsurancePolicies":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Disability Insurance Policies for the specified Fact Finder ID. \r\n Purpose: Provides access to the Disability Insurance Policies including description and policy type.","operationId":"DisabilityInsurancePolicies_GetDisabilityInsurancePoliciesByFactFinderIdByFactfinderid","parameters":[{"description":"The ID of the Fact Finder used to retrieve Disability Insurance Policies","in":"query","name":"factFinderId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePoliciesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePoliciesModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Disability Insurance Policy."},"403":{"description":"Request is restricted for access to Disability Insurance Policy."},"404":{"description":"Disability Insurance Policy not found."}},"tags":["DisabilityInsurancePolicies"]},"post":{"deprecated":false,"description":"Description: The operation creates a Disability Insurance Policy. \r\n Purpose: Allows for creation of Disability Insurance Policies on a Fact Finder.","operationId":"DisabilityInsurancePolicies_PostByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyModel"}}},"description":"The Disability Insurance Policy to be added to the Fact Finder","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Disability Insurance Policy."},"403":{"description":"Request is restricted for access to Disability Insurance Policy."},"404":{"description":"Disability Insurance Policy not found."}},"tags":["DisabilityInsurancePolicies"]}},"/api/DisabilityInsurancePolicies/{id}":{"delete":{"deprecated":false,"description":"Description: The operation removes a Disability Insurance Policy tied to a Fact Finder. \r\n Purpose: Allows for removal of a Disability Insurance Policy from a Fact Finder.","operationId":"DisabilityInsurancePolicies_DeleteById","parameters":[{"description":"The Disability Insurance Policy ID used to identify which Disability Insurance Policy to remove","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Disability Insurance Policy."},"403":{"description":"Request is restricted for access to Disability Insurance Policy."},"404":{"description":"Disability Insurance Policy not found."}},"tags":["DisabilityInsurancePolicies"]},"get":{"deprecated":false,"description":"Description: This operation retrieves a single Disability Insurance Policy for the specified Disability Insurance Policy ID. \r\n Purpose: Provides access to the Disability Insurance Policy including description and policy type.","operationId":"DisabilityInsurancePolicies_GetById","parameters":[{"description":"The ID of the Disability Insurance Policy used to retreive the Disability Insurance Policy","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Disability Insurance Policy."},"403":{"description":"Request is restricted for access to Disability Insurance Policy."},"404":{"description":"Disability Insurance Policy not found."}},"tags":["DisabilityInsurancePolicies"]},"put":{"deprecated":false,"description":"Description: The operation updates a Disability Insurance Policy. \r\n Purpose: Allows for complete replacement of a Disability Insurance Policy on a Fact Finder.","operationId":"DisabilityInsurancePolicies_PutByIdModel","parameters":[{"description":"The existing Disability Insurance Policy ID used to identify which Disability Insurance Policy to update","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyModel"}}},"description":"The Disability Insurance Policy to be updated on a Fact Finder","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Disability Insurance Policy."},"403":{"description":"Request is restricted for access to Disability Insurance Policy."},"404":{"description":"Disability Insurance Policy not found."}},"tags":["DisabilityInsurancePolicies"]}},"/api/DisabilityInsurancePolicyTypes":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Disability Insurance Policy Types for the specified country. \r\n Purpose: Provides access to the Disability Insurance Policy Types including id and type description.","operationId":"DisabilityInsurancePolicyTypes_GetByCountry","parameters":[{"description":"The country used to filter Disability Insurance Policy Types","in":"query","name":"country","required":true,"schema":{"type":"string","enum":["UnitedStates","Canada"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyTypesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyTypesModel"}}}},"400":{"description":"The request is invalid."},"404":{"description":"Disability Insurance Policy Type not found."}},"tags":["DisabilityInsurancePolicyTypes"]}},"/api/DisabilityInsurancePolicyTypes/{id}":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Disability Insurance Policy Types for the specified id. \r\n Purpose: Provides access to the Disability Insurance Policy Types including id and type description.","operationId":"DisabilityInsurancePolicyTypes_GetById","parameters":[{"description":"The ID of Disability Insurance Policy Type used to retreive the Disability Insurance Policy Type information","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyTypeModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.DisabilityInsurancePolicyTypeModel"}}}},"400":{"description":"The request is invalid."},"404":{"description":"Disability Insurance Policy Type not found."}},"tags":["DisabilityInsurancePolicyTypes"]}},"/api/EducationGoals":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Education Goals for the specified Fact Finder ID. \r\n Purpose: Provides access to the Education Goals including description and projected cost.","operationId":"EducationGoals_GetEducationGoalsByFactFinderIdByFactfinderid","parameters":[{"description":"The ID of the Fact Finder used to retrieve Education Goals","in":"query","name":"factFinderId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationGoalsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationGoalsModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Education Goal."},"403":{"description":"Request is restricted for access to Education Goal."},"404":{"description":"Education Goal not found."}},"tags":["EducationGoals"]},"post":{"deprecated":false,"description":"Description: The operation creates an Education Goal. \r\n Purpose: Allows for creation of Education Goals on a Fact Finder.","operationId":"EducationGoals_PostByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationGoalModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationGoalModel"}}},"description":"The Education Goal to be added to the Fact Finder","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationGoalWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationGoalWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Education Goal."},"403":{"description":"Request is restricted for access to Education Goal."},"404":{"description":"Education Goal not found."}},"tags":["EducationGoals"]}},"/api/EducationGoals/{educationGoalId}/Expenses":{"get":{"deprecated":false,"description":"Description: This operation retrieves all Education Goal Expenses for the specified Education Goal ID. \r\n Purpose: Provides access to the Education Goal Expenses including description and annual cost.","operationId":"EducationGoals_GetEducationExpensesByEducationGoalIdByEducationgoalid","parameters":[{"description":"The ID of the Education Goal used to retrieve Education Goal Expenses","in":"path","name":"educationGoalId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationExpensesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationExpensesModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Education Goal Expense."},"403":{"description":"Request is restricted for access to Education Goal Expense."},"404":{"description":"Education Goal Expense not found."}},"tags":["EducationGoals"]},"post":{"deprecated":false,"description":"Description: The operation creates an Education Goal Expense. \r\n Purpose: Allows for creation of Education Goal Expenses on a Fact Finder.","operationId":"EducationGoals_PostByEducationgoalidModel","parameters":[{"description":"The Education Goal ID used to locate the Goal to add the expense to","in":"path","name":"educationGoalId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"$ref":"#/components/requestBodies/Advicent.FactFinderService.Models.EducationExpenseModel"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationExpenseWithIdModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Advicent.FactFinderService.Models.EducationExpenseWithIdModel"}}}},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Education Goal Expense."},"403":{"description":"Request is restricted for access to Education Goal Expense."},"404":{"description":"Education Goal Expense not found."}},"tags":["EducationGoals"]}},"/api/EducationGoals/{educationGoalId}/Expenses/{id}":{"delete":{"deprecated":false,"description":"Description: The operation removes an Education Goal Expense tied to a Fact Finder. \r\n Purpose: Allows for removal of an Education Goal Expense from a Fact Finder.","operationId":"EducationGoals_DeleteByEducationgoalidId","parameters":[{"description":"The Education Goal ID used to locate the Goal to delete the Expense under","in":"path","name":"educationGoalId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The Education Goal Expense ID used to identify which Education Goal Expense to remove","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request is invalid."},"401":{"description":"Request is unauthorized for access to Education Goal Expense."},"403":{"description":"Request is rest