Versions Compared

Key

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

This method returns a list of all the partner's users.

SOAP Request

Code Block
languagexml
titleXML
<?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>
    <GetUserList xmlns="http://websvcs.quikforms.com/Partner">
      <CustomerID>int</CustomerID>
      <CustUserID>string</CustUserID>
      <Email>string</Email>
      <LName>string</LName>
      <FName>string</FName>
      <UserStatudID>int</UserStatudID>
    </GetUserList>
  </soap:Body>
</soap:Envelope>


SOAP Request Parameters

Field Name

Data Type

Required?

Description

CustomerID

Integer

???No

The customer ID that belongs to the user's customer account

CustUserID

String

???No

The customer's unique ID for the user
EmailString???No
The email associated to the user
LNameString???NoThe last name associated to the user
FNameString???NoThe first name associated to the user
UserStatudIDInteger??????No

The User Status ID. Available values are:

1 Pending
2 Active
3 Inactive
4 DeleteĀ 

SOAP Response

Code Block
languagexml
titleXML
<?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>
    <GetUserListResponse xmlns="http://websvcs.quikforms.com/Partner">
      <GetUserListResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
      </GetUserListResult>
    </GetUserListResponse>
  </soap:Body>
</soap:Envelope>


Result Fields

The ResultData contains the following fields:

Field Name

Data Type

Description

???

???

???

???

???

???

CustomerID

Integer

The customer ID that belongs to the user's customer account

UserID

Integer

The user ID that belongs to the customer account
CustUserIDStringThe customer's unique ID for the user
FNameStringThe first name associated to the user
LNameStringThe last name associated to the user
EmailStringThe email associated to the user
UserStatusStringThe User Status
UserStatusIDIntegerThe ID of the User Status
LastUpdateDateDate of last user record update
LastUserIDIntegerID of User that updated the recordĀ