Bombshell Agency Platform Service

<back to all web services

CaseDesignExpectedStrategyRequest

The following routes are available for this service:
POST,PUT,OPTIONS/CaseDesignExpectedStrategy

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/CaseDesignExpectedStrategyRequest HTTP/1.1 
Host: api.responsible-advisor.com 
Content-Type: text/jsv
Content-Length: length

{
	InputObject: 
	{
		Id: 0,
		CaseDesignId: 0,
		SectionName: String,
		Label: String,
		ValueA: String,
		FactFinder_Parent_id: 0,
		FactFinderParent: 
		{
			ParentId: 0,
			FactFinderId: 0,
			ParentNumber: 0,
			MotherFather: String,
			Name: String,
			DOB: 0001-01-01,
			PhoneNumber: String,
			Email: String,
			HaveWillOrTrust: False,
			LastWillTrustReviewDate: 0001-01-01,
			CurrentAge: 0,
			PersonalHealthRating: 0,
			FinancialHealthRating: 0,
			NumberOfSiblings: 0,
			HaveLongTermCarePlan: False,
			HaveLegacyPlan: False,
			Notes: String,
			Employer: String,
			Title: String,
			YearsOfService: 0,
			CurrentAnnualIncome: 0,
			Bonus: 0,
			BonusNotAvailable: False,
			PreviousEmployer: String,
			PreviousYearsOfService: 0,
			IsVeteran: False,
			AmountOfGIBillCollegeBenefits: 0,
			OtherIncomeDisability: 0,
			OtherIncomeDisabilityNotAvailable: False,
			OtherIncomeNonTaxable: 0,
			OtherIncomeNonTaxableNotAvailable: False,
			OtherIncomeTaxable: 0,
			OtherIncomeTaxableNotAvailable: False,
			OtherIncomeTrust: 0,
			OtherIncomeTrustNotAvailable: False,
			OtherIncomeBusiness: 0,
			OtherIncomeBusinessNotAvailable: False,
			OtherIncomeRental: 0,
			OtherIncomeRentalNotAvailable: False,
			W2_Box1: 0,
			W2_Box12a: 0,
			W2_Box12a_Code: String,
			W2_Box12b: 0,
			W2_Box12b_Code: String,
			W2_Box12c: 0,
			W2_Box12c_Code: String,
			W2_Box12d: 0,
			W2_Box12d_Code: String,
			Pension_LumpSum: 0,
			Pension_AnnualBenefit: 0,
			Pension_Age: 0,
			SocialSecurity: 0,
			CheckingSavings: 0,
			CheckingSavingsMonthlyCont: 0,
			IdealEmergencyFund: 0,
			CurrentEmergencyFund: 0,
			Priorities_PayForCollegeStrategy: 0,
			Priorities_AffordingUnfundedFutureHealthcareCost: 0,
			Priorities_NotBeingBurdenToChildrenInRetirement: 0,
			Priorities_LoweringFutureTaxObligations: 0,
			Priorities_BuildingRetirementNextEgg: 0,
			Priorities_ProtectingSavingsFromFutureMarketDownturnsAndCrashes: 0,
			Priorities_ReducingParentDebtDuringCollege: 0,
			Priorities_BuildingKeepingEmergencyFund: 0,
			Priorities_LeavingLegacy: 0,
			Priorities_Other: 0,
			Priorities_OtherExplanation: String,
			Priorities_BestThingWeTalkedAboutToday: String,
			UnfundedHealthCareCost: 0,
			FSAHSA_Option: String,
			FSAHSA_AnnualContributions: 0,
			FSAHSA_AnnualCap: 0,
			EstimatedAnnualSocialSecurityBenefit: 0,
			BusinessValue: 0,
			RetirementPlans: 
			[
				{
					RetirementPlanId: 0,
					FactFinderId: 0,
					ParentNumber: 0,
					QualifiedPlan: False,
					RetirementPlanTypeId: 0,
					Value: 0,
					AnnualContribution: 0,
					AnnualIncomeYield: 0,
					CompanyMatch: 0,
					ManagedBy: String,
					ExpectedRateOfReturn: 0,
					NotAvailable: False,
					RetirementPlanType: 
					{
						Id: 0,
						Name: String,
						Description: String,
						TaxableDistributions: False,
						AnnualContributionLimits: 0,
						RequiredDistribution: 0,
						RequiredDistributionAge: 0,
						EmployerMatching: False,
						DefinedBenefitPlan: False,
						AdjustsWithInflation: False,
						EarlyWithdrawalPenaltyPercent: 0,
						CatchupContributionMinimumAge: 0,
						CatchupContributionAnnualLimit: 0,
						HasCashBalance: False,
						Qualified: False,
						Portable: False,
						LifetimeBenefit: False,
						DateModified: 0001-01-01,
						DateCreated: 0001-01-01,
						CreatedBy: String,
						LastUpdatedBy: String
					}
				}
			]
		},
		ValueB: String,
		ValueC: String,
		ValueD: String,
		SourceId: 0,
		DateCreated: 0001-01-01,
		DateModified: 0001-01-01
	},
	Insert: False,
	Delete: False,
	Update: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	OutputObject: 
	{
		Id: 0,
		CaseDesignId: 0,
		SectionName: String,
		Label: String,
		ValueA: String,
		FactFinder_Parent_id: 0,
		FactFinderParent: 
		{
			ParentId: 0,
			FactFinderId: 0,
			ParentNumber: 0,
			MotherFather: String,
			Name: String,
			DOB: 0001-01-01,
			PhoneNumber: String,
			Email: String,
			HaveWillOrTrust: False,
			LastWillTrustReviewDate: 0001-01-01,
			CurrentAge: 0,
			PersonalHealthRating: 0,
			FinancialHealthRating: 0,
			NumberOfSiblings: 0,
			HaveLongTermCarePlan: False,
			HaveLegacyPlan: False,
			Notes: String,
			Employer: String,
			Title: String,
			YearsOfService: 0,
			CurrentAnnualIncome: 0,
			Bonus: 0,
			BonusNotAvailable: False,
			PreviousEmployer: String,
			PreviousYearsOfService: 0,
			IsVeteran: False,
			AmountOfGIBillCollegeBenefits: 0,
			OtherIncomeDisability: 0,
			OtherIncomeDisabilityNotAvailable: False,
			OtherIncomeNonTaxable: 0,
			OtherIncomeNonTaxableNotAvailable: False,
			OtherIncomeTaxable: 0,
			OtherIncomeTaxableNotAvailable: False,
			OtherIncomeTrust: 0,
			OtherIncomeTrustNotAvailable: False,
			OtherIncomeBusiness: 0,
			OtherIncomeBusinessNotAvailable: False,
			OtherIncomeRental: 0,
			OtherIncomeRentalNotAvailable: False,
			W2_Box1: 0,
			W2_Box12a: 0,
			W2_Box12a_Code: String,
			W2_Box12b: 0,
			W2_Box12b_Code: String,
			W2_Box12c: 0,
			W2_Box12c_Code: String,
			W2_Box12d: 0,
			W2_Box12d_Code: String,
			Pension_LumpSum: 0,
			Pension_AnnualBenefit: 0,
			Pension_Age: 0,
			SocialSecurity: 0,
			CheckingSavings: 0,
			CheckingSavingsMonthlyCont: 0,
			IdealEmergencyFund: 0,
			CurrentEmergencyFund: 0,
			Priorities_PayForCollegeStrategy: 0,
			Priorities_AffordingUnfundedFutureHealthcareCost: 0,
			Priorities_NotBeingBurdenToChildrenInRetirement: 0,
			Priorities_LoweringFutureTaxObligations: 0,
			Priorities_BuildingRetirementNextEgg: 0,
			Priorities_ProtectingSavingsFromFutureMarketDownturnsAndCrashes: 0,
			Priorities_ReducingParentDebtDuringCollege: 0,
			Priorities_BuildingKeepingEmergencyFund: 0,
			Priorities_LeavingLegacy: 0,
			Priorities_Other: 0,
			Priorities_OtherExplanation: String,
			Priorities_BestThingWeTalkedAboutToday: String,
			UnfundedHealthCareCost: 0,
			FSAHSA_Option: String,
			FSAHSA_AnnualContributions: 0,
			FSAHSA_AnnualCap: 0,
			EstimatedAnnualSocialSecurityBenefit: 0,
			BusinessValue: 0,
			RetirementPlans: 
			[
				{
					RetirementPlanId: 0,
					FactFinderId: 0,
					ParentNumber: 0,
					QualifiedPlan: False,
					RetirementPlanTypeId: 0,
					Value: 0,
					AnnualContribution: 0,
					AnnualIncomeYield: 0,
					CompanyMatch: 0,
					ManagedBy: String,
					ExpectedRateOfReturn: 0,
					NotAvailable: False,
					RetirementPlanType: 
					{
						Id: 0,
						Name: String,
						Description: String,
						TaxableDistributions: False,
						AnnualContributionLimits: 0,
						RequiredDistribution: 0,
						RequiredDistributionAge: 0,
						EmployerMatching: False,
						DefinedBenefitPlan: False,
						AdjustsWithInflation: False,
						EarlyWithdrawalPenaltyPercent: 0,
						CatchupContributionMinimumAge: 0,
						CatchupContributionAnnualLimit: 0,
						HasCashBalance: False,
						Qualified: False,
						Portable: False,
						LifetimeBenefit: False,
						DateModified: 0001-01-01,
						DateCreated: 0001-01-01,
						CreatedBy: String,
						LastUpdatedBy: String
					}
				}
			]
		},
		ValueB: String,
		ValueC: String,
		ValueD: String,
		SourceId: 0,
		DateCreated: 0001-01-01,
		DateModified: 0001-01-01
	}
}