Open topic with navigation

Customer Server

The Customer Server web service provides several Web methods for interacting with customers. For Instant SOLO Server Shared URL, this can be reached at https://secure.softwarekey.com/solo/webservices/customerserver.asmx. If you are using Instant SOLO Server Custom Shared URL or Instant SOLO Server Dedicated URL, replace secure.softwarekey.com with your sub-domain/domain. If you are running a standalone version of SOLO Server, replace secure.softwarekey.com/solo in the URL with the path to your SOLO Server instance. Please contact us if you need assistance determining the correct URL.

The customerserver.asmx web service offers the following methods:

CreateCustomer

Creates a new customer or modifies an existing customer with the same email/password combination. This method requires passing in a SOLO Server Author ID, User ID and password.  Additionally, the specified user must have Add Single Customer permission.

Important

Since this web method requires providing an AuthorID, UserID, and User Password as inputs, it should be used for internal applications only and should not be called by client applications distributed to customers. Using this web method in a client application exposes a security risk as this would require including SOLO Server login credentials in the distributed product.

Important

The optional fields listed below are considered optional in the SOLO Server database. Specifying a blank value will result in the respective field being updated with an empty value in the database.

Input

Parameter Data Type Required/Optional Description
authorID int Required The SOLO Server Author ID with which the customer will be created.
userID string Required The SOLO Server UserID within the SOLO Server Author's roster of authorized SOLO Server users that is creating the new customer.
userPassword string Required The password affiliated with the SOLO Server UserID.
companyName string Optional The name of the customer's company. Pass in an empty string if a company name has not been specified or is otherwise unavailable.
firstName string Optional The customer's first name.
lastName string Optional The customer's last name.
address1 string Optional The customer's address, line #1.
address2 string Optional The customer's address, line #2. Pass in an empty string if a second address line has not been specified or is otherwise unavailable.
city string Optional The customer's city.
stateProvince string Optional The customer state/province. For US and Canadian addresses, this should be validated to be a valid state/province code. See State Codes and Country Strings as well as Client Validation Script for details on validation.
postalCode string Optional The customer postal code. For US and Canadian addresses, this should be validated to be a valid postal code. See State Codes and Country Strings as well as Client Validation Script for details on validation.
country string Optional The customer's country. This should be a valid SOLO Server country string. See State Codes and Country Strings as well as Client Validation Script for details on validation.
email string Required The customer's e-mail address.
password string Required The new customer password.
phone string Optional The customer's phone number. Pass in an empty string if a phone number has not been specified or is otherwise unavailable.
fax string Optional The customer's fax number. Pass in an empty string if a fax number has not been specified or is otherwise unavailable.
nickname string Optional The customer's external reference. The external reference field on the customer was previously the nickname field, and the parameter name in this method has been left unchanged to preserve backwards compatibility with existing integrations.
offerProduct string Required Pass in True to sign-up the customer for receipt of product e-mails; otherwise, pass in False.
offerPartners string Required Pass in True to sign-up the customer for receipt of partner e-mails; otherwise, pass in False.

Output

The result DataSet contains the following parameters:

Parameter Data Type Description
Failure
ResultCode int The result code could be:
  • -1 - The Author ID, User ID, and user password combination is invalid, or the user account does not have proper permissions to add customer records.
  • -2 - A nickname was specified, but is not available because it is already in use.
Sucess
CustomerID int The Customer ID is returned when all the input values are valid and a customer is created.