SWS ExportInsuranceDetail Method
Retrieves a collection of insurance information for a specified provider. The provider is assigned an external ID number to access the insurance information from Store. This data is not necessarily relevant to a Store user.
Parameters
Name | DataType | Is Required |
---|---|---|
Code | String | Required |
Description | The external ID number assigned to the insurance provider for extracting data from Store. | |
EndDate | DateTime | Optional |
Description | The date to end a process. If a start date is provided, then it is the end date of a range of dates. Technically, it’s one day beyond the end date. | |
StartDate | DateTime | Required |
Description | The date to start a process. If end date is provided, then it is the start date of a range of dates. |
Returned Parameters
Name | DataType |
---|---|
ACCT_CLASS | String |
Description | The account class. |
ACCT_NAME | 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. |
ADDR1 | String |
Description | The first line of the rentals address. |
ADDR2 | String |
Description | The second line of the rentals address. |
ATTRIBUTE01 | String |
Description | The textual value for the “Attribute01” custom lookup as defined by the site. See eUnitAttr01 for the available values. |
ATTRIBUTE02 | String |
Description | The textual value for the “Attribute02” custom lookup as defined by the site. See eUnitAttr02 for the available values. |
CITY | String |
Description | The city for the address. |
COVERAGE_AMOUNT | Integer |
Description | The insurance policy’s coverage amount for the rental item. |
COVERAGE_GROUP_ID | Long |
Description | The insurance coverage group’s ID number. |
COVERAGE_PERC | Decimal |
Description | The insurance policy’s coverage percentage for the rental item. |
FIRST_NAME | String |
Description | The given name for the account/rental contact. |
GROUP_NAME | String |
Description | The insurance coverage group’s name. |
INS_OPTION_ID | Long |
Description | The insurance policy’s option ID number. |
INS_PROVIDER_ID | Long |
Description | The insurance coverage provider’s ID number. |
LAST_NAME | String |
Description | The family name for the rental contact. |
ORG_ID | Long |
Description | The organization’s ID number. |
ORG_NAME | String |
Description | The organization’s name. |
POSTAL_CODE | String |
Description | The postal/ZIP code for the address. |
PROVIDER_EXT_ID | String |
Description | The external ID number extended to the insurance provider for extracting data from Store. |
PROVIDER_NAME | String |
Description | The insurance coverage group’s name. |
RATE | Decimal |
Description | The insurance policy’s premium amount for the rental item. |
SITE_ID | Long |
Description | The site’s ID number. |
SITE_NAME | String |
Description | The site’s name. |
SITE_NUMBER | String |
Description | The site’s number as assigned by the admin. |
SITE_REF_ID | String |
Description | The site specific provider ID number, if it exists. |
START_DATE | DateTime |
Description | The date to start a process. If end date is provided, then it is the start date of a range of dates. |
STATE | String |
Description | The state/province for the address. |
UNIT_NUMBER | String |
Description | The site assigned unit number of the rental item. This is not the UnitID. |
Example
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 ExportInsuranceDetail request object and a ExportInsuranceDetail response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.ExportInsuranceDetail_Request request = new SWS.ExportInsuranceDetail_Request();
SWS.ExportInsuranceDetail_Response response;
Here’s my sample code of the Request object.
// ExportInsuranceDetail Request
request.Code = "ABC123";
request.StartDate = DateTime.Today.AddDays(1);
request.EndDate = DateTime.Today;
Finally we can call the method and pass in the request object to export our insurance detail. 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.ExportInsuranceDetail(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.