GetInsurancePolicies

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdsGuid[]The BrickIds (unique id) of the insurance policy
2.02.20160603
OwnerIdsGuid[]Owner/holder of the policy
2.02.20160603
CreatedDateToDateTimeThe date on which the insurance policy was createdIf one of these values are used as input both of them has to be supplied2.02.20160603
CreatedDateFromDateTime
2.02.20160603
AccountIdsGuid[]The BrickIds of accounts associated with the insurance policy
2.02.20160603
PolicyNosstring[]The policy numbers of the insurance policies
2.02.20160603
SecondInsuredLegalEntityIdsGuid[]The BrickIds of the second insured Legal Entities
2.02.20160603
ExpirationDateToDateTimeThe expiration date range of the insurance policyIf one of these values are used as input both of them has to be supplied2.02.20160603
ExpirationDateFromDateTime
2.02.20160603
Statusint[]

The statuses of the insurance policies

1 = Active, 2 = Inactive


2.02.20160603
Premiumsdecimal[]The value of the insurance premium
2.02.20160603
PremiumFrequenciesint[]

The premium frequency entered as number of months.


2.02.20160603
Parametersstring[]This is a string with custom parameters separated by semicolons. For example if a car insurance policy was created and the brand of the car should be stored and the production year the contents of this property could be "brand=Ford;year=2016".
2.02.20160603
SignDateToDateTimeThe date when the policy was signedIf one of these values are used as input both of them has to be supplied2.02.20160603
SignDateFromDateTime
2.02.20160603
TerminationDateToDateTimeThe date when the policy should be terminatedIf one of these values are used as input both of them has to be supplied2.02.20160603
TerminationDateFromDateTime
2.02.20160603
CancellationDateToDateTimeThe date when the policy was cancelledIf one of these values are used as input both of them has to be supplied2.02.20160603
CancellationDateFromDateTime
2.02.20160603
PeriodStartDateToDateTimeThe date on which the policy period was startedIf one of these values are used as input both of them has to be supplied2.02.20160603
PeriodStartDateFromDateTime
2.02.20160603
PeriodEndDateToDateTimeThe date on which the policy period endedIf one of these values are used as input both of them has to be supplied2.02.20160603
PeriodEndDateFromDateTime
2.02.20160603
InitialActivationDateToDateTimeThe initial activation date of the policyIf one of these values are used as input both of them has to be supplied2.02.20160603
InitialActivationDateFromDateTime
2.02.20160603
InsuranceProgramIdsGuid[]The BrickId of the associated insurance program
2.02.20160603
InsuranceProgramNamestring[]The name of the associated insurance program
2.02
ExternalReferencesstring[]The external reference set on the insurance policy
2.02.20160603
PolicyPeriodsint[]

The policy period entered as number of months.



2.02.20160603

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuidThe BrickId (unique id) of the insurance policy2.02.20160603
OwnerIdGuidOwner/holder of the policy2.02.20160603
AccountIdGuidThe linked BFS account for the insurance policy2.02.20160603
CreatedDateDateTimeDate when insurance policy was created2.02.20160603
PolicyNostringNumber of the policy2.02.20160603
SecondInsuredLegalEntityIdGuidThe BrickId of the second insured Legal Entities2.02.20160603
ExpirationDateDateTimeDate when policy expires2.02.20160603
StatusintStatus of policy2.02.20160603
PremiumintPremium value for the policy2.02.20160603
PremiumFrequencyint

The premium frequency entered as number of months.


2.02.20160603
ParametersstringThis is a string with custom parameters separated by semicolons. For example if a car insurance policy was created and the brand of the car should be stored and the production year the contents of this property could be "brand=Ford;year=2016".2.02.20160603
SignDateDateTimeDate when policy was signed2.02.20160603
TerminationDateDateTimeDate when policy was closed2.02.20160603
CancellationDateDateTimeDate when policy was cancelled2.02.20160603
PeriodStartDateDateTimeThe date on which the policy period was started2.02.20160603
PeriodEndDateDateTimeThe date on which the policy period was ended2.02.20160603
InsuranceProgramIdGuidThe BrickId of the product the policy is based on2.02.20160603
InsuranceProgramNamestringThe name of the product the policy is based on2.02
ExternalReferencestringThe external reference set on the insurance policy2.02.20160603
PolicyPeriodint

The period of the policy entered in number of months

2.02.20160603
InitialActivationDateDateTimeThe date on which the insurance initially was activated2.02.20160603

Code examples

C# - Get insurance policies
//Use the GetInsurancePolicies method
var client = new BFSServiceReference.bfsapiSoapClient();

var credentials = new BFSServiceReference.Credentials()
{
    UserName = bfsusername, //Username of administrative user in your instance of BFS
    Password = bfspassword, //Password of the administrative user in your instance of BFS
};

var orders = client.GetInsurancePolicies(new BFSServiceReference.GetInsurancePolicyRequest()
{
    Credentials = credentials,

    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS 

    Args = new GetInsurancePolicyArgs()
    {
        PolicyNos = new[]
        {
            "20014288",
            "20012787"
        },
    },

    Fields = new BFSServiceReference.GetInsurancePolicyFields()
    {
        BrickId = true,
        InsuranceProgramId = true,
		InsuranceProgramName = true,
        OwnerId = true,
        AccountId = true,
        PolicyPeriod = true,
        ExternalReference = true,
        CreatedDate = true,
        ExpirationDate = true,
        PolicyNo = true,
        InitialActivationDate = true,
        PeriodStartDate = true,
        Status = true,
        Parameters = true,
        PeriodEndDate = true,
        SignDate = true,
        Premium = true,
        PremiumFrequency = true,
        CancellationDate = true,
        SecondInsuredLegalEntityId = true,
        TerminationDate = true       
    },

});

foreach (var c in orders.Result)
{
    Console.WriteLine(c.BrickId + ";" +
        c.InsuranceProgramId + ";" +
        c.InsuranceProgramName + ";" +
        c.OwnerId + ";" +
        c.PolicyPeriod + ";" +
        c.ExternalReference + ";" +
        c.CreatedDate + ";" +
        c.ExpirationDate + ";" +
        c.PolicyNo + ";" +
        c.InitialActivationDate + ";" +
        c.PeriodStartDate + ";" +
        c.PeriodEndDate + ";" +
        c.SignDate + ";" +
        c.Premium + ";" +
        c.PremiumFrequency + ";" +
        c.CancellationDate + ";" +
        c.SecondInsuredLegalEntityId + ";" +
        c.TerminationDate + ";" +
        c.AccountId);
}

Blog stream

Create a blog post to share news and announcements with your team and company.