Archive

Archive for the ‘Insurance’ Category

SWS GetInsCancelWarningLetterInfo Method

October 24, 2016 Leave a comment

This method allows insurance providers to access insurance cancellation warning letter data including when and where the letter was sent.

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.
RentalID Long Required
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.

Returned Parameters

Name DataType
LetterName String
Description The name of the letter that was sent.
UnitNum String
Description The unit’s number as assigned by the organization. This is not the UnitID.
RentalID Long
Description The rental’s ID number.
CustomerAccountName String
Description The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account.
CustomerFirstName String
Description The contact’s first name.
CustomerLastName String
Description The customer’s last name.
CustomerAddressLine1 String
Description Line one of the contact’s address.
CustomerAddressLine2 String
Description Line two of the contact’s address.
CustomerCity String
Description The city of the contact’s address.
CustomerState String
Description The state/province for the contact’s address.
CustomerPostalCode String
Description The postal code from the customer’s address.
SiteID Long
Description The site’s ID number.
SiteName String
Description The name of the site where the rental is located.
OperatorNumber Long
Description The user’s id that created the letter.
DaysInsuranceIsCancelled Long
Description The number of days before insurance will be cancelled from the date the letter was sent.
DaysLetterSent Long
Description The number of days since the letter was sent.
DateLetterCreated DateTime
Description The date the letter was created.
ProjectedInsuranceCancellationDate DateTime
Description The expected date of cancellation.
CancellationDate DateTime
Description If cancellation has occurred, the date insurance was cancelled.
InsuranceEffectiveEndDate DateTime
Description The last date of coverage.

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, an GetInsCancelWarningLetterInfo request object and an GetInsCancelWarningLetterInfo response object.  We can define and create those like this:

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

Now we set up the parameters for our request.

// get letter data request
request.OrgID = 123456;
request.SiteID = 123456;
request.RentalID = 123546;

Finally we can call the method and pass across the login object and the request object to retrieve the data. It’s a good idea to do this in a Try Catch block.

try
{
    // Call the method that will load the response object
    response = service.GetInsCancelWarningLetterInfo(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.

Categories: API General, Insurance, Letters

SWS GetInsuranceBrokerLocations Method

December 8, 2011 2 comments

Returns all of the Store sites for an organization insurance broker services. This method requires that the user has access to the insurance tables through special permissions; otherwise, an error is returned.

Parameters

Name DataType Is Required
InsBrokerOrgID Long Required
Description The insurance companies’ system generated organization id number. This is not the same as the OrgID.

Returned Parameters

Name DataType
Locations String
Description An XML string of Store sites and organizations for an insurance broker that can be read into a .Net DataSet or parsed using an XML parser.

Example

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

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object, a GetInsuranceBrokerLocations request object, and a GetInsuranceBrokerLocations response object. We can define and create those like this:

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

Here is a sample code of the request object:

// GetInsuranceBrokerLocations Request
request.InsBrokerOrgID = 123456;

Finally we can call the method and pass across the login object and the request object to retrieve our requested information. 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.GetInsuranceBrokerLocations(user_request,request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: API General, Insurance

SWS GetInsuranceBrokerData Method

December 8, 2011 3 comments

Returns all of the insurance data on an insurance broker for the specified site and date. This method requires that the user has access to the insurance tables through special permissions; otherwise, an error is returned.

Parameters

Name DataType Is Required
InsBrokerOrgID Long Required
Description The organization’s ID number.
LocationSiteID Long Required
Description The site ID for the site from which the insurance company wishes to pull data.
SnapshotDate DateTime Required
Description The date to generate a snapshot of the insurance data. If today, only the data up to the current time will be returned.

Returned Parameters

Name DataType
InsuranceData String
Description An XML string of insurance broker data that can be read into a .Net DataSet or parsed using an XML parser. Note: Any return parameter that does not have a value will not be displayed in the XML generated.

Example

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

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object, a GetInsuranceBrokerData request object, and a GetInsuranceBrokerData response object. We can define and create those like this:

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

Here is a sample code of the request object:

// GetInsuranceBrokerData Request
request.InsBrokerOrgID = 123456;
request.LocationSiteID = 123456;
request.SnapshotDate = DateTime.Today;

Finally we can call the method and pass across the login object and the request object to retrieve our requested information. 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.GetInsuranceBrokerData(user_request,request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: API General, Insurance

SWS UpdateInsurance Method

May 29, 2011 1 comment

Changes the existing insurance coverage to a different insurance coverage. This will not add insurance if the customer doesn’t currently have existing coverage.

Parameters

Name Data Type Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
RentalID Long Required
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
NewInsuranceOptionID Long Required
Description The id for the specific insurance option to which you are chaning the rental. Use the INS_OPTION_ID from the GetInsuranceProviders method.

Returned Parameters

Name Data Type
CreditsReturned Decimal
Description The amount of funds returned to the customer due to the change of insurance.
AmountDueAfterUpdate Decimal
Description The amount of funds owed on the account due to the change of insurance.
TransactionID Long
Description The transaction’s ID number. Transaction IDs are system generated for each transaction that occurs in the system. A null or “0” response indicates the transaction failed.
InsuranceRentalID Long
Description The RentalID applicable to the new insurance assessment.

Example

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

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

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object, an UpdateInsurance request object, and an UpdateInsurance response object. We can define and create those like this:

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

Here is a sample code of the request object:

// UpdateInsurance Request
request.SiteID = 123456;
request.RentalID = 126456;
request.NewInsuranceOptionID = 123456;

Finally we can call the method and pass across the login object and the request object to retrieve our requested information. 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.UpdateInsurance(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: API General, Insurance Tags: