Bombshell Agency Platform Service

<back to all web services

PolicyRequest

The following routes are available for this service:
GET, OPTIONS/v1/Policy/{PolicyNumber}

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

{
	PolicyNumber: String
}
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
			}
		]
	},
	Policy: 
	{
		IssueDate: 0001-01-01,
		PolicyNumber: String,
		Insured: String,
		Carrier: String,
		Plan: String,
		Premium: 0,
		CommissionRate: 0,
		Part: 0,
		AdvanceRate: 0,
		PolicyType: String,
		PolicyCode: String,
		Age: 0,
		ControlledBusiness: False,
		StatusId: 0,
		Type: String,
		PayoutsSoFar: 0,
		TotalPayouts: 0,
		PaidSoFar: 0,
		AdvanceAmount: 0,
		TotalPayoutAmount: 0,
		CanGenerateFutureCommissionRecords: False,
		Statuses: 
		[
			{
				ID: 0,
				PendingStatusName: String,
				PendingStatusDescription: String
			}
		],
		WritingAgents: 
		[
			{
				Id: 0,
				PolicyNumber: String,
				AgentId: 0,
				AgentNumber: String,
				AgentName: String,
				Part: 0
			}
		],
		CommissionRecords: 
		[
			{
				Id: 0,
				DateCreated: 0001-01-01,
				AgentNumber: String,
				AgentName: String,
				PolicyNumber: String,
				InsuredAnnuitant: String,
				ProcessDate: 0001-01-01,
				Premium: 0,
				GrossCommission: 0,
				CommRate: 0,
				Part: 0,
				PaymentDate: 0001-01-01,
				PolicyType: String,
				Company: String,
				AgentId: 0,
				DateProcessed: 0001-01-01,
				CommissionBatchId: 0,
				Market: String,
				PriorPlan: {},
				EffectiveDate: 0001-01-01,
				ProductType: String,
				PlanType: String,
				LinkedId: {},
				PaymentPercent: 0,
				Plan: String,
				Product: String,
				MID: String,
				IssueAge: 0,
				ChargebackAgent: {},
				LastUpdatedUser: String,
				AdvanceRate: 0,
				ApprovalDate: 0001-01-01,
				NumberOfCommissionListings: 0,
				ComponentsToProcess: String,
				CappedPayout: False,
				ContactId: 0,
				IsRenewal: False,
				AgentNPN: String,
				CommissionPolicyId: 0,
				SourceTypeId: 0,
				SunfireId: 0,
				AppSubmitDate: 0001-01-01,
				SourceTypeName: String,
				CommissionBatchTitle: String,
				FieldPayoutPercent: 0,
				CommissionRecordId: 0,
				Hierarchy: 
				[
					{
						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
					}
				],
				WritingAgent: 
				{
					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
				},
				RunningTotalRemaining: 0,
				ProcessingClawback: False,
				CommissionListings: 
				[
					{
						ID: 0,
						ProcessDate: 0001-01-01,
						PaymentDate: 0001-01-01,
						AgentId: 0,
						AgentName: String,
						OAgentID: 0,
						OAgent: String,
						Policy: String,
						PolicyType: String,
						Insured: String,
						Premium: 0,
						Part: 0,
						PartPercent: 0,
						Amount: 0,
						Company: String,
						Gross: 0,
						AgentNumber: String,
						CommissionRate: 0,
						Description: String,
						CommissionBatchId: 0,
						Adjustment: False,
						CommissionRecordId: 0,
						FieldPayoutPercent: 0,
						AgentLevel: 0,
						DateCreated: 0001-01-01,
						SunfireId: 0,
						CommissionFutureListingId: 0,
						CommissionRecordTempRerunId: 0,
						CommissionNote: String,
						OrigProcessDate: 0001-01-01,
						OrigPaymentDate: 0001-01-01,
						CanPublish: False,
						CompensationDimensionId: String,
						AppSubmitDate: 0001-01-01,
						MedicareIdNumber: String,
						CommissionPolicyId: 0,
						EffectiveDate: 0001-01-01,
						PayTypeId: 0,
						StatementString: String,
						SubmitDate: 0001-01-01
					}
				]
			}
		],
		CommissionListings: 
		[
			{
				ID: 0,
				ProcessDate: 0001-01-01,
				PaymentDate: 0001-01-01,
				AgentId: 0,
				AgentName: String,
				OAgentID: 0,
				OAgent: String,
				Policy: String,
				PolicyType: String,
				Insured: String,
				Premium: 0,
				Part: 0,
				PartPercent: 0,
				Amount: 0,
				Company: String,
				Gross: 0,
				AgentNumber: String,
				CommissionRate: 0,
				Description: String,
				CommissionBatchId: 0,
				Adjustment: False,
				CommissionRecordId: 0,
				FieldPayoutPercent: 0,
				AgentLevel: 0,
				DateCreated: 0001-01-01,
				SunfireId: 0,
				CommissionFutureListingId: 0,
				CommissionRecordTempRerunId: 0,
				CommissionNote: String,
				OrigProcessDate: 0001-01-01,
				OrigPaymentDate: 0001-01-01,
				CanPublish: False,
				CompensationDimensionId: String,
				AppSubmitDate: 0001-01-01,
				MedicareIdNumber: String,
				CommissionPolicyId: 0,
				EffectiveDate: 0001-01-01,
				PayTypeId: 0,
				StatementString: String,
				SubmitDate: 0001-01-01
			}
		],
		FutureCommissionRecords: 
		[
			{
				Id: 0,
				DateCreated: 0001-01-01,
				PayoutNumber: 0,
				ToBeMovedDate: 0001-01-01,
				MovedDate: 0001-01-01,
				AgentNumber: String,
				AgentName: String,
				PolicyNumber: String,
				InsuredAnnuitant: String,
				ProcessDate: 0001-01-01,
				Premium: 0,
				GrossCommission: 0,
				CommRate: 0,
				Part: 0,
				PolicyType: String,
				Company: String,
				AgentId: 0,
				IsRenewal: False,
				PolicyCode: String,
				Age: 0,
				AdvanceRate: 0,
				Plan: String,
				ControlledBusiness: False,
				CappedPayout: 0,
				LastUpdatedUser: String,
				CommissionRecordId: 0,
				CommissionBatchId: 0,
				NumberOfFutureCommissionListings: 0,
				FutureCommissionListings: 
				[
					{
						Id: 0,
						Type: String,
						TotalAmount: 0,
						TotalPayouts: 0,
						PayoutNumber: 0,
						ToBeMovedDate: 0001-01-01,
						MovedDate: 0001-01-01,
						CommissionListingId: 0,
						ProcessDate: 0001-01-01,
						PaymentDate: 0001-01-01,
						AgentId: 0,
						AgentName: String,
						OAgentID: 0,
						OAgent: String,
						Policy: String,
						PolicyType: String,
						Insured: String,
						Premium: 0,
						Part: 0,
						PartPercent: 0,
						Amount: 0,
						Company: String,
						Gross: 0,
						AgentNumber: String,
						CommissionRate: 0,
						Description: String,
						CommissionBatchId: 0,
						Adjustment: False,
						FutureCommissionRecordId: 0,
						Plan: String,
						AdvanceRate: 0,
						CommissionPercent: 0,
						AgentLevel: 0,
						GloEligible: False,
						LastUpdatedUser: String,
						ApprovalDate: 0001-01-01
					}
				]
			}
		],
		FutureCommissionListings: 
		[
			{
				Id: 0,
				Type: String,
				TotalAmount: 0,
				TotalPayouts: 0,
				PayoutNumber: 0,
				ToBeMovedDate: 0001-01-01,
				MovedDate: 0001-01-01,
				CommissionListingId: 0,
				ProcessDate: 0001-01-01,
				PaymentDate: 0001-01-01,
				AgentId: 0,
				AgentName: String,
				OAgentID: 0,
				OAgent: String,
				Policy: String,
				PolicyType: String,
				Insured: String,
				Premium: 0,
				Part: 0,
				PartPercent: 0,
				Amount: 0,
				Company: String,
				Gross: 0,
				AgentNumber: String,
				CommissionRate: 0,
				Description: String,
				CommissionBatchId: 0,
				Adjustment: False,
				FutureCommissionRecordId: 0,
				Plan: String,
				AdvanceRate: 0,
				CommissionPercent: 0,
				AgentLevel: 0,
				GloEligible: False,
				LastUpdatedUser: String,
				ApprovalDate: 0001-01-01
			}
		],
		Hierarchies: 
		[
			{
				Id: 0,
				PolicyNumber: String,
				WritingAgentId: 0,
				PolicyWritingAgent: 
				{
					Id: 0,
					PolicyNumber: String,
					AgentId: 0,
					AgentNumber: String,
					AgentName: String,
					Part: 0
				},
				HierarchyDate: 0001-01-01
			}
		],
		PolicyNotes: 
		[
			{
				Id: 0,
				PolicyNumber: String,
				Username: String,
				Message: String,
				CreatedDate: 0001-01-01
			}
		],
		PolicyCommissionRecordsLogs: 
		[
			{
				CommissionRecordLogs: 
				[
					{
						Id: 0,
						CommissionRecordId: 0,
						DateCreated: 0001-01-01,
						AgentNumber: String,
						AgentName: String,
						PolicyNumber: String,
						InsuredAnnuitant: String,
						ProcessDate: 0001-01-01,
						Premium: 0,
						GrossCommission: 0,
						CommRate: 0,
						Part: 0,
						PaymentDate: 0001-01-01,
						PolicyType: String,
						Company: String,
						AgentId: 0,
						DateProcessed: 0001-01-01,
						IsRenewal: False,
						PolicyCode: String,
						Age: 0,
						CommissionBatchId: 0,
						AdvanceRate: 0,
						Plan: String,
						CarrierAgentNumber: String,
						ControlledBusiness: False,
						CappedPayout: 0,
						FileBatchId: 0,
						FileDate: 0001-01-01,
						LastUpdatedUser: String,
						ApprovalDate: 0001-01-01,
						DateModified: 0001-01-01,
						ChangeType: String
					}
				],
				CommissionRecordId: 0
			}
		],
		CurrentPayoutMatrix: 
		{
			Id: 0,
			Tier: String,
			ProductType: String,
			FullComp: 0,
			AgentPay: 0,
			AdminFee: 0,
			Payout: 0,
			PayoutType: String,
			AdjustedPayout: 0,
			PolicyState: String,
			PlanType: String,
			FullCompPerMonth: 0,
			AgentPayPerMonth: 0,
			AdminFeePerMonth: 0,
			Carrier: String
		}
	}
}