Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This method returns a list of licenses for a given list of CustomerIDs in the partner's account.

SOAP Request

Code Block
languagexml
titleXML
<?xml version="1.0" encoding="utf-8"?>

...



<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

...



<soap12:Header>

...



<AuthenticationHeader xmlns="http://websvcs.quikforms.com/Partner">

...



<PartnerID>string</PartnerID>

...


<UserName>string</UserName>

...


<Password>string</Password>

...



</AuthenticationHeader>

...



</soap12:Header>

...



<soap12:Body>

...



<GetCustomerLicenseList xmlns="http://websvcs.quikforms.com/Partner">

...


<CustomerIDs>string</CustomerIDs>

...


<CustomerUniqueIDs>string</CustomerUniqueIDs>

...


<ProductID>int</ProductID>

...


<CustomerProductStatusID>int</CustomerProductStatusID>

...


<RenewalDateStart>dateTime</RenewalDateStart>

...


<RenewalDateEnd>dateTime</RenewalDateEnd>

...



</GetCustomerLicenseList>

...



</soap12:Body>

...



</soap12:Envelope>

SOAP Body Request Parameters

The following parameters can be used with this web service. Required parameters are highlighted in RED. To return all licenses for all customers in the partner account leave all the parameters empty.

Field Name

Data Type

Length

Direction

Display

Required?

Description

CustomerIDs

String

8000

In

YES

NO

Comma-separated list of CustomerIDs

CustomerUniqueIDs

String

8000

In

YES

NO

A list of the Partner's Unique IDs assigned by the partner system to identify customers

ProductID

Integer

4

In

YES

NO

Optional value to return customers who have a given ProductID.

CustomerProductStatusID

Integer

4

In

YES

NO

Optional value to restrict results by product status.

RenewalDateStart

Date

8

In

YES

NO

Optional value to restrict results to a starting renewal date

RenewalDateEnd

Date

8

In

YES

NO

Optional value to restrict results to an ending renewal date

SOAP Response


Code Block
languagexml
titleXML
<?xml version="1.0" encoding="utf-8"?>

...



<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

...



<soap12:Body>

...



<GetCustomerLicenseListResponse xmlns="http://websvcs.quikforms.com/Partner">

...

<GetCustomerLicenseListResult>

<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>

<xsd:schema>schema</xsd:schema>xml</ResultData>

</GetCustomerLicenseListResult>

</GetCustomerLicenseListResponse>



<GetCustomerLicenseListResult>

<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>

<xsd:schema>schema</xsd:schema>xml</ResultData>

</GetCustomerLicenseListResult>

</GetCustomerLicenseListResponse>

</soap12:Body>

...



</soap12:Envelope>

Result Fields

The ResultData contains the following fields.

...