Home > API General, Insurance, Site Administration > SWS GetInsuranceProviders Method

SWS GetInsuranceProviders Method


Retrieves insurance/protection plan providers available to the site.

Parameters

Name DataType Is Required
OrgID Long Required
Description The organization’s ID number.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
CANCEL_AFTER Integer
Description The number of days delinquent the rental can be before the policy is automatically cancelled.
COMMENTS String
Description The comments on the insurance/protection plan.
COVERAGE_AMOUNT Integer
Description The dollar amount of coverage that the insurance/protection plan offers.
COVERAGE_PERC Integer
Description The percentage of coverage that the insurance/protection plan covers.
DEFAULT_OPTION String
Description Indicates if the insurance/protection plan group is the default for the organization (“Y”) or not (“N”).
DESC1 String
Description The full description of the insurance/protection plan coverage.
DESC2 String
Description A shortened version of insurance/protection plan coverage description.
DISP_ACTIVE String
Description Indicates if the insurance/protection plan is active at the site (“Y”) or not (“N”).
GROUP_ACTIVE String
Description Indicates if the insurance/protection plan coverage group is active at the site (“Y”) or not (“N”).
GROUP_NAME String
Description The name of the insurance/protection plan’s group as assigned by the organization.
INS_OPTION_ID Long
Description The insurance/protection plan’s ID number.
INS_PROVIDER_ID Long
Description The insurance/protection plan provider’s ID number.
OPTION_ACTIVE String
Description Within each coverage group there are different levels of coverage. This indicates if the specific level of coverage is available at the organization (“Y”) or not (“N”).
ORG_ID Long
Description The organization’s ID number.
PROVIDER_ACTIVE String
Description Indicates if the provider of the insurance/protection plan is active at the organization (“Y”) or not (“N”).
PROVIDER_NAME String
Description The insurance/protection plan provider’s name.
PROVIDER_NOTES String
Description The notes on the insurance/protection plan’s coverage provider.
RATE Decimal
Description The insurance/protection plan’s premium amount for the service.
SITE_ACTIVE String
Description Indicates if the insurance/protection plan is active at the site (“Y”) or not (“N”).
SITE_ID Long
Description The site’s ID number.
SITE_INS_ID Long
Description The insurance/protection plan provider’s site ID number.
SITE_REF_ID String
Description The site specific provider ID number, if it exists.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to our objects.  We’ll need the standard service object, a GetInsuranceProviders request object and a GetInsuranceProviders response object.  We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetInsuranceProviders_Request request = new SWS.GetInsuranceProviders_Request();
SWS.GetInsuranceProviders_Response response;

Here’s my sample code of the Request object.

// GetInsuranceProviders Request
request.OrgID = 123456;
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to get our insurance/protection plan providers. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  response = service.GetInsuranceProviders(user_request,request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.

  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: