This method adds or updates licenses for a single customer account that is related to the partner's account.

SOAP Request

XML

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="http://websvcs.quikforms.com/Partner">
      <PartnerID>string</PartnerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <AddOrUpdateLicense xmlns="http://websvcs.quikforms.com/Partner">
      <CustomerID>int</CustomerID>
      <CustomerUserUniqueID>string</CustomerUserUniqueID>
      <ProductID>int</ProductID>
      <ProductLicenseStatusID>int</ProductLicenseStatusID>
      <ProductLicenseExpiryDate>dateTime</ProductLicenseExpiryDate>
      <FirstName>string</FirstName>
      <MiddleName>string</MiddleName>
      <LastName>string</LastName>
      <Suffix>string</Suffix>
      <EMail>string</EMail>
      <Phone>string</Phone>
      <PhoneExt>string</PhoneExt>
      <Fax>string</Fax>
      <AddressLine1>string</AddressLine1>
      <AddressLine2>string</AddressLine2>
      <AddressLine3>string</AddressLine3>
      <AddressLine4>string</AddressLine4>
      <City>string</City>
      <StateID>int</StateID>
      <Zip>string</Zip>
      <CountryID>int</CountryID>
    </AddOrUpdateLicense>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

The following parameters can be used with this web service. Required parameters are highlighted in RED. This method only operates against a single license as indicated by the CustomerID and the CustomerUserUniqueID values. You need only enter the values you wish to update and any parameters that are not populated will remain unchanged. If you wish to clear a value, populate the parameter with a space.

Field Name	Data Type	Length	Direction	Display	Required?	Description
CustomerID	Integer	4	In	YES	YES	The customer's CustomerID to associate the license
CustomerUserUniqueID	String	250	In	YES	YES	The customer's unique ID to use for the license name (e.g. advisor name, rep name, user name, customer's UNID, any value that represents the license for the customer).
ProductID	Integer	4	In	YES	NO	Default value if left blank is ProductID 14 (Quik! Forms Engine). Any valid/active product ID can be passed.
ProductLicenseStatusID	Integer	4	In	YES	NO	If adding a new license, set the value to ACTIVE. If updating and empty, leave status the same.
ProductLicenseExpiryDate	Date	8	In	YES	NO	Date to expire the product license
FirstName	String	250	In	YES	NO	Licensee's First Name – if no first or last name, use the CustomerUser UniqueID as First Name
MiddleName	String	250	In	YES	NO	Licensee's Middle Name
LastName	String	250	In	YES	NO	Licensee's Last Name
Suffix	String	250	In	YES	NO	Licensee's Suffix
Email	String	1000	In	YES	NO	Licensee's Email
Phone	String	25	In	YES	NO	Licensee's Phone
PhoneExt	String	25	In	YES	NO	Licensee's Phone Extension
Fax	String	25	In	YES	NO	Licensee's Fax
AddressLine1	String	1000	In	YES	NO	Licensee's Address line 1
AddressLine2	String	1000	In	YES	NO	Licensee's Address line 2
AddressLine3	String	1000	In	YES	NO	Licensee's Address line 3
AddressLine4	String	1000	In	YES	NO	Licensee's Address line 4
City	String	1000	In	YES	NO	Licensee's City
StateID	Integer	4	In	YES	NO	Licensee's State ID
Zip	String	15	In	YES	NO	Licensee's Zip Code
CountryID	Integer	4	In	YES	NO	Licensee's Country ID

Product License Status ID

The following statuses apply to the Product License Status:

ProductLicenseStatusID	ProductLicenseStatus	ProductLicenseStatusDesc
1	Active	The license is active and available for use
2	Inactive	The license is inactive and cannot be used
3	Delete	The license was marked for deletion

SOAP Response

XML

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddOrUpdateLicenseResponse xmlns="http://websvcs.quikforms.com/Partner">
      <AddOrUpdateLicenseResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
      </AddOrUpdateLicenseResult>
    </AddOrUpdateLicenseResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

The ResultData contains the following fields.

Field Name	Data Type	Length	Description
CustomerID	Integer		CustomerID for the added/updated record
CustomerUserUniqueID	Integer		Customer's User UNID for the added/updated record
ProductLicenseExpiryDate	Date		Date the license expires (returns NULL if no expiry date)
ProductLicenseStatusID	Integer		Product License Status ID
ProductLicenseStatus	String	255 chars	Status of the product license record

Quik! API Guide

AddOrUpdateLicense Method

SOAP Request

SOAP Body Request Parameters

Product License Status ID

SOAP Response

Result Fields