Bombshell Agency Platform Service

<back to all web services

PolicyProductRequest

The following routes are available for this service:
GET,DELETE,OPTIONS/v1/PolicyProduct/{PolicyProductId}
GET,POST,PUT,OPTIONS/v1/PolicyProduct

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/PolicyProductRequest HTTP/1.1 
Host: api2.exactmedicare.com 
Content-Type: text/jsv
Content-Length: length

{
	PolicyProduct: 
	{
		Id: 0,
		ProductTypeId: 0,
		Name: String,
		Description: String,
		StartDate: 0001-01-01,
		EndDate: 0001-01-01,
		DateModified: 0001-01-01,
		LastUserModified: String,
		PolicyProductType: 
		{
			Id: 0,
			Name: String,
			Description: String,
			DateCreated: 0001-01-01,
			DateModified: 0001-01-01,
			LastUserModified: String
		},
		PolicyProductTags: 
		[
			{
				Id: 0,
				ProductId: 0,
				ProductTag: String,
				DateCreated: 0001-01-01,
				DateModified: 0001-01-01,
				LastUserModified: String
			}
		],
		PolicyProductCompensation: 
		{
			CompensationMethod: 
			{
				Id: 0,
				Name: String,
				Description: String,
				DateCreated: 0001-01-01,
				DateModified: 0001-01-01,
				LastUserModified: String
			},
			CompensationTiming: 
			{
				Id: 0,
				Name: String,
				Description: String,
				FrequencyId: 0,
				PolicyProductFrequency: 
				{
					Id: 0,
					Name: String,
					Description: String,
					DateCreated: 0001-01-01,
					DateModified: 0001-01-01,
					LastUserModified: String
				},
				OffsetDays: 0,
				Repeat: False,
				DateCreated: 0001-01-01,
				DateModified: 0001-01-01,
				LastUserModified: String
			},
			CompensationDimensions: 
			[
				{
					Id: 0,
					Name: String,
					Description: String,
					PolicyProductId: 0,
					PolicyProductCompensationMethodId: 0,
					PolicyProductCompensationDimensionTypeId: 0,
					PolicyProductCompensationDimensionKey: String,
					PolicyProductCompensationDimensionValue: String,
					PolicyProductCompensationTypeId: 0,
					DimensionGroup: 0,
					DateCreated: 0001-01-01,
					DateModified: 0001-01-01,
					LastUserModified: String,
					PlanTypeId: 0,
					DimensionTypes: 
					{
						Id: 0,
						Name: String,
						Description: String,
						Priority: 0,
						DateCreated: 0001-01-01,
						DateModified: 0001-01-01,
						LastUserModified: String
					},
					DimensionDurations: 
					[
						{
							Id: 0,
							PolicyProductCompensationDimensionId: 0,
							Name: String,
							DateKey: String,
							StartDate: 0001-01-01,
							EndDate: 0001-01-01,
							DateModified: 0001-01-01,
							LastUserModified: String,
							PlanTypeId: 0,
							PayTypeId: 0
						}
					]
				}
			],
			CorporateAgent: 
			{
				AgentId: 0,
				Company: String,
				AgentName: String,
				FirstName: String,
				LastName: String,
				MiddleInitial: String,
				Address1: String,
				Address2: String,
				City: String,
				State: String,
				Zip: String,
				Country: String,
				Email: String,
				EmailSignature: String,
				BusinessEmail: String,
				HomePhone: String,
				CellPhone: String,
				WorkPhone: String,
				InsLicensed: False,
				AgreeToDisclosures: False,
				AgreeToDate: 0001-01-01,
				PaidDate: 0001-01-01,
				AgentNumber: String,
				AccountTypeId: 0,
				ReferringAgent: String,
				PlacementAgent: String,
				CreatedDate: 0001-01-01,
				UserId: 00000000000000000000000000000000,
				IsAgent: False,
				Package: String,
				StoreName: String,
				Notes: String,
				Upline1: 0,
				Upline2: 0,
				Upline3: 0,
				Upline4: 0,
				MVPID: 0,
				AVPID: 0,
				RVPID: 0,
				AgentLevel: 0,
				IsMVP: False,
				IsRVP: False,
				IsAVP: False,
				IsAdmin: False,
				IsBusinessCardAdmin: False,
				TeamName: String,
				CalendarId: 00000000000000000000000000000000,
				Rank: String,
				NBC: False,
				Upline1Percent: 0,
				Upline2Percent: 0,
				Upline3Percent: 0,
				Upline4Percent: 0,
				AgentStatus: String,
				Office: String,
				DOB: 0001-01-01,
				SSN: String,
				Fax: String,
				ModifiedDate: 0001-01-01,
				ModifiedBy: String,
				TimeZone: String,
				LeaderLocked: False,
				LastSubmittedBusinessDate: 0001-01-01,
				GracePeriodDate: 0001-01-01,
				Vested: False,
				DirectPay: 0001-01-01,
				DirectPayApprBy: String,
				FactFinderBilling: 0,
				IsSecurityLicensed: False,
				ProfilePicture: String,
				MailingAddress1: String,
				MailingAddress2: String,
				MailingCity: String,
				MailingState: String,
				MailingZip: String,
				RegistrationRequirementMet: False,
				AgentNPN: String,
				LicenseType: String,
				EBShares: 0,
				ABShares: 0,
				AgentTypeId: 0,
				StartDate: 0001-01-01,
				PartnerID: 0,
				AccountRelationship: String,
				OverrideDirect: False,
				OverrideIndirect: False,
				ReadyToSell: 0001-01-01,
				TerminationDate: 0001-01-01
			},
			topPartnerAgent: 
			{
				AgentId: 0,
				Company: String,
				AgentName: String,
				FirstName: String,
				LastName: String,
				MiddleInitial: String,
				Address1: String,
				Address2: String,
				City: String,
				State: String,
				Zip: String,
				Country: String,
				Email: String,
				EmailSignature: String,
				BusinessEmail: String,
				HomePhone: String,
				CellPhone: String,
				WorkPhone: String,
				InsLicensed: False,
				AgreeToDisclosures: False,
				AgreeToDate: 0001-01-01,
				PaidDate: 0001-01-01,
				AgentNumber: String,
				AccountTypeId: 0,
				ReferringAgent: String,
				PlacementAgent: String,
				CreatedDate: 0001-01-01,
				UserId: 00000000000000000000000000000000,
				IsAgent: False,
				Package: String,
				StoreName: String,
				Notes: String,
				Upline1: 0,
				Upline2: 0,
				Upline3: 0,
				Upline4: 0,
				MVPID: 0,
				AVPID: 0,
				RVPID: 0,
				AgentLevel: 0,
				IsMVP: False,
				IsRVP: False,
				IsAVP: False,
				IsAdmin: False,
				IsBusinessCardAdmin: False,
				TeamName: String,
				CalendarId: 00000000000000000000000000000000,
				Rank: String,
				NBC: False,
				Upline1Percent: 0,
				Upline2Percent: 0,
				Upline3Percent: 0,
				Upline4Percent: 0,
				AgentStatus: String,
				Office: String,
				DOB: 0001-01-01,
				SSN: String,
				Fax: String,
				ModifiedDate: 0001-01-01,
				ModifiedBy: String,
				TimeZone: String,
				LeaderLocked: False,
				LastSubmittedBusinessDate: 0001-01-01,
				GracePeriodDate: 0001-01-01,
				Vested: False,
				DirectPay: 0001-01-01,
				DirectPayApprBy: String,
				FactFinderBilling: 0,
				IsSecurityLicensed: False,
				ProfilePicture: String,
				MailingAddress1: String,
				MailingAddress2: String,
				MailingCity: String,
				MailingState: String,
				MailingZip: String,
				RegistrationRequirementMet: False,
				AgentNPN: String,
				LicenseType: String,
				EBShares: 0,
				ABShares: 0,
				AgentTypeId: 0,
				StartDate: 0001-01-01,
				PartnerID: 0,
				AccountRelationship: String,
				OverrideDirect: False,
				OverrideIndirect: False,
				ReadyToSell: 0001-01-01,
				TerminationDate: 0001-01-01
			}
		}
	},
	PolicyProductId: 0
}
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
			}
		]
	},
	PolicyProducts: 
	[
		{
			Id: 0,
			ProductTypeId: 0,
			Name: String,
			Description: String,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			DateModified: 0001-01-01,
			LastUserModified: String,
			PolicyProductType: 
			{
				Id: 0,
				Name: String,
				Description: String,
				DateCreated: 0001-01-01,
				DateModified: 0001-01-01,
				LastUserModified: String
			},
			PolicyProductTags: 
			[
				{
					Id: 0,
					ProductId: 0,
					ProductTag: String,
					DateCreated: 0001-01-01,
					DateModified: 0001-01-01,
					LastUserModified: String
				}
			],
			PolicyProductCompensation: 
			{
				CompensationMethod: 
				{
					Id: 0,
					Name: String,
					Description: String,
					DateCreated: 0001-01-01,
					DateModified: 0001-01-01,
					LastUserModified: String
				},
				CompensationTiming: 
				{
					Id: 0,
					Name: String,
					Description: String,
					FrequencyId: 0,
					PolicyProductFrequency: 
					{
						Id: 0,
						Name: String,
						Description: String,
						DateCreated: 0001-01-01,
						DateModified: 0001-01-01,
						LastUserModified: String
					},
					OffsetDays: 0,
					Repeat: False,
					DateCreated: 0001-01-01,
					DateModified: 0001-01-01,
					LastUserModified: String
				},
				CompensationDimensions: 
				[
					{
						Id: 0,
						Name: String,
						Description: String,
						PolicyProductId: 0,
						PolicyProductCompensationMethodId: 0,
						PolicyProductCompensationDimensionTypeId: 0,
						PolicyProductCompensationDimensionKey: String,
						PolicyProductCompensationDimensionValue: String,
						PolicyProductCompensationTypeId: 0,
						DimensionGroup: 0,
						DateCreated: 0001-01-01,
						DateModified: 0001-01-01,
						LastUserModified: String,
						PlanTypeId: 0,
						DimensionTypes: 
						{
							Id: 0,
							Name: String,
							Description: String,
							Priority: 0,
							DateCreated: 0001-01-01,
							DateModified: 0001-01-01,
							LastUserModified: String
						},
						DimensionDurations: 
						[
							{
								Id: 0,
								PolicyProductCompensationDimensionId: 0,
								Name: String,
								DateKey: String,
								StartDate: 0001-01-01,
								EndDate: 0001-01-01,
								DateModified: 0001-01-01,
								LastUserModified: String,
								PlanTypeId: 0,
								PayTypeId: 0
							}
						]
					}
				],
				CorporateAgent: 
				{
					AgentId: 0,
					Company: String,
					AgentName: String,
					FirstName: String,
					LastName: String,
					MiddleInitial: String,
					Address1: String,
					Address2: String,
					City: String,
					State: String,
					Zip: String,
					Country: String,
					Email: String,
					EmailSignature: String,
					BusinessEmail: String,
					HomePhone: String,
					CellPhone: String,
					WorkPhone: String,
					InsLicensed: False,
					AgreeToDisclosures: False,
					AgreeToDate: 0001-01-01,
					PaidDate: 0001-01-01,
					AgentNumber: String,
					AccountTypeId: 0,
					ReferringAgent: String,
					PlacementAgent: String,
					CreatedDate: 0001-01-01,
					UserId: 00000000000000000000000000000000,
					IsAgent: False,
					Package: String,
					StoreName: String,
					Notes: String,
					Upline1: 0,
					Upline2: 0,
					Upline3: 0,
					Upline4: 0,
					MVPID: 0,
					AVPID: 0,
					RVPID: 0,
					AgentLevel: 0,
					IsMVP: False,
					IsRVP: False,
					IsAVP: False,
					IsAdmin: False,
					IsBusinessCardAdmin: False,
					TeamName: String,
					CalendarId: 00000000000000000000000000000000,
					Rank: String,
					NBC: False,
					Upline1Percent: 0,
					Upline2Percent: 0,
					Upline3Percent: 0,
					Upline4Percent: 0,
					AgentStatus: String,
					Office: String,
					DOB: 0001-01-01,
					SSN: String,
					Fax: String,
					ModifiedDate: 0001-01-01,
					ModifiedBy: String,
					TimeZone: String,
					LeaderLocked: False,
					LastSubmittedBusinessDate: 0001-01-01,
					GracePeriodDate: 0001-01-01,
					Vested: False,
					DirectPay: 0001-01-01,
					DirectPayApprBy: String,
					FactFinderBilling: 0,
					IsSecurityLicensed: False,
					ProfilePicture: String,
					MailingAddress1: String,
					MailingAddress2: String,
					MailingCity: String,
					MailingState: String,
					MailingZip: String,
					RegistrationRequirementMet: False,
					AgentNPN: String,
					LicenseType: String,
					EBShares: 0,
					ABShares: 0,
					AgentTypeId: 0,
					StartDate: 0001-01-01,
					PartnerID: 0,
					AccountRelationship: String,
					OverrideDirect: False,
					OverrideIndirect: False,
					ReadyToSell: 0001-01-01,
					TerminationDate: 0001-01-01
				},
				topPartnerAgent: 
				{
					AgentId: 0,
					Company: String,
					AgentName: String,
					FirstName: String,
					LastName: String,
					MiddleInitial: String,
					Address1: String,
					Address2: String,
					City: String,
					State: String,
					Zip: String,
					Country: String,
					Email: String,
					EmailSignature: String,
					BusinessEmail: String,
					HomePhone: String,
					CellPhone: String,
					WorkPhone: String,
					InsLicensed: False,
					AgreeToDisclosures: False,
					AgreeToDate: 0001-01-01,
					PaidDate: 0001-01-01,
					AgentNumber: String,
					AccountTypeId: 0,
					ReferringAgent: String,
					PlacementAgent: String,
					CreatedDate: 0001-01-01,
					UserId: 00000000000000000000000000000000,
					IsAgent: False,
					Package: String,
					StoreName: String,
					Notes: String,
					Upline1: 0,
					Upline2: 0,
					Upline3: 0,
					Upline4: 0,
					MVPID: 0,
					AVPID: 0,
					RVPID: 0,
					AgentLevel: 0,
					IsMVP: False,
					IsRVP: False,
					IsAVP: False,
					IsAdmin: False,
					IsBusinessCardAdmin: False,
					TeamName: String,
					CalendarId: 00000000000000000000000000000000,
					Rank: String,
					NBC: False,
					Upline1Percent: 0,
					Upline2Percent: 0,
					Upline3Percent: 0,
					Upline4Percent: 0,
					AgentStatus: String,
					Office: String,
					DOB: 0001-01-01,
					SSN: String,
					Fax: String,
					ModifiedDate: 0001-01-01,
					ModifiedBy: String,
					TimeZone: String,
					LeaderLocked: False,
					LastSubmittedBusinessDate: 0001-01-01,
					GracePeriodDate: 0001-01-01,
					Vested: False,
					DirectPay: 0001-01-01,
					DirectPayApprBy: String,
					FactFinderBilling: 0,
					IsSecurityLicensed: False,
					ProfilePicture: String,
					MailingAddress1: String,
					MailingAddress2: String,
					MailingCity: String,
					MailingState: String,
					MailingZip: String,
					RegistrationRequirementMet: False,
					AgentNPN: String,
					LicenseType: String,
					EBShares: 0,
					ABShares: 0,
					AgentTypeId: 0,
					StartDate: 0001-01-01,
					PartnerID: 0,
					AccountRelationship: String,
					OverrideDirect: False,
					OverrideIndirect: False,
					ReadyToSell: 0001-01-01,
					TerminationDate: 0001-01-01
				}
			}
		}
	]
}