CredenzaLicenseServer

Click here for a complete list of operations.

GetClients

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /AmicusLicensingService.asmx HTTP/1.1
Host: qa.amicuslicensing.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.credenzasoft.com/GetClients"

<?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>
    <GetClients xmlns="http://www.credenzasoft.com/">
      <token>
        <ExpirationDateAndTime>dateTime</ExpirationDateAndTime>
        <Hash>string</Hash>
      </token>
      <filter>
        <ClientIdentifier>guid</ClientIdentifier>
        <Name>string</Name>
        <PrimaryEmailAddress>string</PrimaryEmailAddress>
        <ConsentId>string</ConsentId>
      </filter>
    </GetClients>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <GetClientsResponse xmlns="http://www.credenzasoft.com/">
      <GetClientsResult>
        <Client>
          <Name>string</Name>
          <PhoneNumbers>
            <PhoneNumber xsi:nil="true" />
            <PhoneNumber xsi:nil="true" />
          </PhoneNumbers>
          <Addresses>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </Addresses>
          <ConsentId>string</ConsentId>
          <PrimaryEmailAddress>string</PrimaryEmailAddress>
          <PasswordTip>string</PasswordTip>
          <Password>string</Password>
          <ReferenceName>string</ReferenceName>
          <ReferralIdentifier>guid</ReferralIdentifier>
          <IsGrandFatheredLicense>boolean</IsGrandFatheredLicense>
        </Client>
        <Client>
          <Name>string</Name>
          <PhoneNumbers>
            <PhoneNumber xsi:nil="true" />
            <PhoneNumber xsi:nil="true" />
          </PhoneNumbers>
          <Addresses>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </Addresses>
          <ConsentId>string</ConsentId>
          <PrimaryEmailAddress>string</PrimaryEmailAddress>
          <PasswordTip>string</PasswordTip>
          <Password>string</Password>
          <ReferenceName>string</ReferenceName>
          <ReferralIdentifier>guid</ReferralIdentifier>
          <IsGrandFatheredLicense>boolean</IsGrandFatheredLicense>
        </Client>
      </GetClientsResult>
    </GetClientsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /AmicusLicensingService.asmx HTTP/1.1
Host: qa.amicuslicensing.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?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>
    <GetClients xmlns="http://www.credenzasoft.com/">
      <token>
        <ExpirationDateAndTime>dateTime</ExpirationDateAndTime>
        <Hash>string</Hash>
      </token>
      <filter>
        <ClientIdentifier>guid</ClientIdentifier>
        <Name>string</Name>
        <PrimaryEmailAddress>string</PrimaryEmailAddress>
        <ConsentId>string</ConsentId>
      </filter>
    </GetClients>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?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>
    <GetClientsResponse xmlns="http://www.credenzasoft.com/">
      <GetClientsResult>
        <Client>
          <Name>string</Name>
          <PhoneNumbers>
            <PhoneNumber xsi:nil="true" />
            <PhoneNumber xsi:nil="true" />
          </PhoneNumbers>
          <Addresses>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </Addresses>
          <ConsentId>string</ConsentId>
          <PrimaryEmailAddress>string</PrimaryEmailAddress>
          <PasswordTip>string</PasswordTip>
          <Password>string</Password>
          <ReferenceName>string</ReferenceName>
          <ReferralIdentifier>guid</ReferralIdentifier>
          <IsGrandFatheredLicense>boolean</IsGrandFatheredLicense>
        </Client>
        <Client>
          <Name>string</Name>
          <PhoneNumbers>
            <PhoneNumber xsi:nil="true" />
            <PhoneNumber xsi:nil="true" />
          </PhoneNumbers>
          <Addresses>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </Addresses>
          <ConsentId>string</ConsentId>
          <PrimaryEmailAddress>string</PrimaryEmailAddress>
          <PasswordTip>string</PasswordTip>
          <Password>string</Password>
          <ReferenceName>string</ReferenceName>
          <ReferralIdentifier>guid</ReferralIdentifier>
          <IsGrandFatheredLicense>boolean</IsGrandFatheredLicense>
        </Client>
      </GetClientsResult>
    </GetClientsResponse>
  </soap12:Body>
</soap12:Envelope>