GetAvailableInstallers
- Timothy Armstrong
Method used to request a list of the closest installers to the customers zip code that could perform the scope of work identified by the card. This method accepts an object of type InstallCardRequest and sends back the object with the updated information in it.
*Note: If an InstallCard ID is not supplied to this call, installer information listings will be limited to city, state, zip, and distance. This information should be used for instances where a user is simply looking to find if an installer is in their area. For instances where the exact installer is needing to be referenced, the InstallCardID should be specified.
Required Input Parameters
Field |
Data Type |
Required |
Description |
Security Code |
GUID |
Yes |
Assigned by InstallerNet |
ProgramID |
INT |
Yes |
Assigned by InstallerNet |
InstallerFinderZip |
VarChar(10) |
Yes* |
Search Installers by ZipCode.
|
InstallCardID |
VarChar(14) |
No |
Search Installers by InstallCard |
Output Parameters
Field |
Data Type |
Description |
Security Code |
GUID |
Assigned by InstallerNet |
ProgramID |
INT |
Assigned by InstallerNet |
TransactionID |
VarChar(14) |
Client Transaction number |
TransactionType |
Char(1) |
"S" for sale or "R" for return |
Customer Information |
Class |
|
CustInfo.FirstName |
VARCHAR(50) |
|
CustInfo.LastName |
VARCHAR(50) |
|
CustInfo.Address |
VARCHAR(50) |
Shipping address |
CustInfo.Address2 |
VARCHAR(50) |
Shipping address 2 |
CustInfo.City |
VARCHAR(50) |
Shipping City |
CustInfo.State |
CHAR(2) |
Shipping State |
CustInfo.ZipCode |
VARCHAR(10) |
Shipping Zip Code |
CustInfo.Country |
VARCHAR(5) |
USA or CAN |
CustInfo.Phone |
VARCHAR(12) |
Format must be 999-999-9999 |
CustInfo.AltPhone |
VARCHAR(12) |
Format must be 999-999-9999 |
CustInfo.Email |
VARCHAR(50) |
Required if Delivery Method is Electronic |
PurchaseDate |
DateTime |
|
CardModel |
VarChar(20) |
|
ShippingMethod |
VarChar(50) |
Required if Delivery method is Physical |
DeliveryMethod |
CHAR(1) |
"E" = Electronic |
ReceiptNumber |
VarChar(50) |
|
Cost |
MONEY |
Client cost for card. If mis-match, and error will be returned |
LineItem |
INT |
Line item on the client purchase order to the customer. Default to 1 if you do not use line items. |
ClientProductNumber |
VarChar(50) |
|
InstallCardID |
Varchar(14) |
InstallCard number |
Errors |
Class |
If no errors were encountered, the class will include one message with error code of 0. |
Error.Code |
INT |
Code that describes the error that occurred during processing |
Error.Message |
VARCHAR(100) |
Message that corresponds to the code returned |
Installers |
Array of Class |
|
Installers.Name |
VARCHAR(50) |
|
Installers.Address |
VARCHAR(50) |
|
Installers.Address2 |
VARCHAR(50) |
|
Installers.City |
VARCHAR(50) |
|
Installers.State |
CHAR(2) |
|
Installers.ZipCode |
VARCHAR(10) |
|
Installers.Phone |
VARCHAR(20) |
|
Installers.Distance |
INT |
|
Installers.InstallerID |
VARCHAR(10) |
|