Reseller Portal SOAP Web Service - Internal License Managment
The following functions are provided to allow the reseller to create/edit/get postcode software customer account details
Get Price Internal Users
Function GetPriceForInternalFullAddressUsers(ByVal Parameters$, ByVal NoUsers&, ByVal NoAreas&, ByRef PriceToCustomer As Double, ByRef PriceToReseller As Double, ByRef PriceDescToCustomer$, ByRef PriceDescToReseller$, ByVal ResellerAccountID&, ByVal ResellerAccountPassword$, ByRef ErrorDescription$) As Boolean
Function GetPriceForInternalThoroughfareAddressUsers(ByVal Parameters$, ByVal NoUsers&, ByVal NoAreas&, ByRef PriceToCustomer As Double, ByRef PriceToReseller As Double, ByRef PriceDescToCustomer$, ByRef PriceDescToReseller$, ByVal ResellerAccountID&, ByVal ResellerAccountPassword$, ByRef ErrorDescription$) As Boolean
Function GetPriceForInternalPostzonAddressUsers(ByVal Parameters$, ByVal NoUsers&, ByVal NoAreas&, ByRef PriceToCustomer As Double, ByRef PriceToReseller As Double, ByRef PriceDescToCustomer$, ByRef PriceDescToReseller$, ByVal ResellerAccountID&, ByVal ResellerAccountPassword$, ByRef ErrorDescription$) As Boolean
Parameters
Parameter name | Description |
---|---|
Parameters | Not used. For future use |
NoUsers | Number of users to price for |
NoAreas | Full Address can be restricted to individual postcode areas, which costs a lot less than full UK data. Click here for the latest prices |
ResellerAccountID | This is the account ID of your reseller account |
ResellerAccountPassword | Your reseller account password |
Returns
Returns True if success, else error in ErrorDescription$
Name | Description |
---|---|
PriceToCustomer | Is the suggested price, including VAT |
PriceToReseller | Price to the reseller, including VAT |
PriceDescToCustomer | See example below |
PriceDescToReseller | See example below |
ErrorDescription | Any error that may have occurred |
Example code |
Dim CustomerPortal As New CustomerPortal.WebServiceCustomerPortal Dim ErrorDescription$ = "" Dim InpNumberOfUsers& = Me.InpNumberOfUsers.Text If Not CustomerPortal.GetPriceForInternalFullAddressUsers(Parameters, _ |
Example:
For 1 user Internal Full Address call
Returns:
PriceDescToCustomer:
Full PAF £220.00 per user * 1 = £220.00 +VAT
PriceDescToReseller:
Full PAF £187.00 per user * 1 = £187.00 +VAT at 15% commission
Please note: Postcode Areas are not supported for Thoroughfare & Postzon Licenses
Get Price Internal Credit Packs
These are for Full address only
Function GetPriceForInternalFullAddressCreditPacks(ByVal Parameters$, ByVal NoOfCredits&, ByRef PriceToCustomer As Double, ByRef PriceToReseller As Double, ByRef PriceDescToCustomer$, ByRef PriceDescToReseller$, ByVal ResellerAccountID&, ByVal ResellerAccountPassword$, ByRef ErrorDescription$) As Boolean
Parameters
Parameter name | Description |
---|---|
Parameters | Not used. For future use |
NoOfCredits | Number of credits to purchase. These are sold in 500 and 5,000 credit packs. 5,000 are discounted |
ResellerAccountID | This is the account ID of your reseller account |
ResellerAccountPassword | Your reseller account password |
Returns
Returns True if success, else error in ErrorDescription$
Name | Description |
---|---|
PriceToCustomer | Is the suggested price, including VAT |
PriceToReseller | Price to the reseller, including VAT |
PriceDescToCustomer | See example below |
PriceDescToReseller | See example below |
ErrorDescription | Any error that may have occurred |
Example code |
Dim CustomerPortal As New CustomerPortal.WebServiceCustomerPortal Dim ErrorDescription$ = "" Dim InpNumberOfCredits& = Me.InpNumberOfCredits.Text If Not CustomerPortal.GetPriceForInternalFullAddressCreditPacks(Parameters, _ |
Example:
For 6,000 Internal Full Address credits call
Returns:
PriceDescToCustomer:
Full PAF credits £880.00 for * 6,000 credits + VAT
PriceDescToReseller:
Full PAF credits £748.00 for * 6,000 credits + VAT at 15% commission
Please note: This is for Full Address only
Purchase Internal Credit Packs
Function PurchaseWebFullCreditPacks(ByVal Parameters$, ByVal NoOfCredits&, ByRef SummaryDescription$, ByRef PaymentNeededToUs As Double, ByVal CustomerAccountID&, ByVal ResellerAccountID&, ByVal ResellerAccountPassword$, ByRef ErrorDescription$) As Boolean
Parameters
Parameter name | Description |
---|---|
Parameters | Not used. For future use |
NoOfCredits | Number of credits to purchase. These are sold in 500 and 5,000 credit packs. 5,000 are discounted |
CustomerAccountID | Customer to buy License for |
ResellerAccountID | This is the account ID of your reseller account |
ResellerAccountPassword | Your reseller account password |
Returns
Returns True if success, else error in ErrorDescription$
Name | Description |
---|---|
PaymentNeededToUs | Price to the reseller, including VAT. This is the figure that should be paid to us |
SummaryDescription | Text Description of purchase, see below |
ErrorDescription | Any error that may have occurred |
Example code |
Dim CustomerPortal As New CustomerPortal.WebServiceCustomerPortal Dim ErrorDescription$ = "" Dim InpNumberOfCredits& = Me.InpNumberOfUsers.Text If Not CustomerPortal.PurchaseInternalCreditPacks(Parameters, |
Example:
For 6,000 (2 * 500, 1 * 5,000) Internal Full Address credits call
Returns:
SummaryDescription:
Full PAF Internal Lookup credits 1,000 Lookup Credits Less Commission:15%
Full PAF Internal Lookup credits 5,000 Lookup Credits Less Commission:15%
Please note:
- We give immediate access to this license, and therefore expect immediate automatic payment from your system. This is a condition of use of this service. An Invoice and Remittance advice is sent to e-mail address on reseller account
- Please put the customers account number in any bank transactions for us to reconcile easily
- For testing post purchases against TEST accounts only.
- Use DoCommand function to clear any test transactions after testing
- The credit level is returned when searching for an address. Therefore this can be monitored to detect low levels, and thus topped up.
Purchase User License
Function PurchaseInternalFullUsers(ByVal Parameters$, ByVal NoOfUsers&, ByVal Renewall As Boolean, ByRef PaymentNeededToUs As Double, ByVal CustomerAccountID&, ByVal ResellerAccountID&, ByVal ResellerAccountPassword$, ByRef ErrorDescription$) As Boolean
Function PurchaseInternalThoroughfareUsers(ByVal Parameters$, ByVal NoOfUsers&, ByVal Renewall As Boolean, ByRef PaymentNeededToUs As Double, ByVal CustomerAccountID&, ByVal ResellerAccountID&, ByVal ResellerAccountPassword$, ByRef ErrorDescription$) As Boolean
Function PurchaseInternalPostZonUsersByVal Parameters$, ByVal NoOfUsers&, ByVal Renewall As Boolean, ByRef PaymentNeededToUs As Double, ByVal CustomerAccountID&, ByVal ResellerAccountID&, ByVal ResellerAccountPassword$, ByRef ErrorDescription$) As Boolean
Parameters
Parameter name | Description |
---|---|
Parameters | Not used. But any message or extra information you wish to send us as part of the transaction can be sent using this field. |
NoUsers | Number of users to purchase |
Renewall | Should be TRUE if license already exists and you wish to renew it after 12 months. Thus we can extent the license from its expire date. |
CustomerAccountID | Customer to buy License for |
ResellerAccountID | This is the account ID of your reseller account |
ResellerAccountPassword | Your reseller account password |
Returns
Returns True if success, else error in ErrorDescription$
Name | Description |
---|---|
PaymentNeededToUs | Price to the reseller, including VAT. This is the figure that should be paid to us |
ErrorDescription | Any error that may have occurred |
Example code |
Dim CustomerPortal As New CustomerPortal.WebServiceCustomerPortal Dim ErrorDescription$ = "" Dim InpNumberOfUsers& = Me.InpNumberOfUsers.Text If Not CustomerPortal.PurchaseInternalFullUsers(Parameters$, InpNumberOfUsers&, _ End If |
Please note:
- We give immediate access to this license, and therefore expect immediate automatic payment from your system. This is a condition of use of this service. An Invoice and Remittance advice is sent to e-mail address on reseller account
- Please put the customers account number in any bank transactions for us to reconcile easily
- If you wish to purchase a Full license restricted to certain areas then set the Areas in customer record first, as the price will be calculated on the list of areas
- Renewals: After 12 months you should make this call again with Renewall = TRUE.
- For testing post purchases against TEST accounts only.
- Use DoCommand function to clear any test transactions after testing