CredenzaLicenseServer Web Service

CredenzaLicenseServer

Click here for a complete list of operations.

GetAmicusLicensesBySearchFilter

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/GetAmicusLicensesBySearchFilter"

<?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>
    <GetAmicusLicensesBySearchFilter xmlns="http://www.credenzasoft.com/">
      <token>
        <ExpirationDateAndTime>dateTime</ExpirationDateAndTime>
        <Hash>string</Hash>
      </token>
      <searchFilter>
        <LicenseDetailIdentifier>guid</LicenseDetailIdentifier>
        <ValidStartDate>dateTime</ValidStartDate>
        <ValidEndDate>dateTime</ValidEndDate>
        <Type>Unknown or Demonstration or Subscription or Evaluation or InPerpetuity or Not_For_Resale or Cancelled or Financed or BulkPurchased</Type>
        <Types>
          <LicenseType>Unknown or Demonstration or Subscription or Evaluation or InPerpetuity or Not_For_Resale or Cancelled or Financed or BulkPurchased</LicenseType>
          <LicenseType>Unknown or Demonstration or Subscription or Evaluation or InPerpetuity or Not_For_Resale or Cancelled or Financed or BulkPurchased</LicenseType>
        </Types>
        <Product>Unknown or AmicusAttorney or AmicusAccounting or AmicusMobile or OutLawForOutlookForSolos or AmicusDocuments or AmicusTelephone or AmicusAssurance or OutLawForOutlookForMicroFirms or OutLawForOutlookForSmallFirms or OutLawForOutlookForLargeFirms</Product>
        <LicensedMembers>int</LicensedMembers>
        <Status>Unknown or Unverified or Active or Expired or InReadOnlyMode or InGrace or Unregistered or InsufficientLicenses or CancellationPending</Status>
        <LicenseDescription>string</LicenseDescription>
        <CreditCardIdentifier>guid</CreditCardIdentifier>
        <NameOnCreditCard>string</NameOnCreditCard>
        <ClientIdentifier>guid</ClientIdentifier>
        <FirmIdentifier>guid</FirmIdentifier>
        <LastChargedDate>dateTime</LastChargedDate>
        <CancellationDate>dateTime</CancellationDate>
        <StartUpDate>dateTime</StartUpDate>
        <Version>string</Version>
        <State>Unknown or Licensed or Unlicensed</State>
        <LastResponseStatus>Unknown or Failed or Successful or SuccessfulWithMoreInformation or InternalError or ErrorCommunicatingWithCreditCardValidationProvider or ErrorSavingToDatabase or ErrorBadCreditCardData or ErrorBadLicenseData or ErrorFailedToObtainToken or ErrorTokenHasExpired or ErrorFailedToConnectToLicensingServer or ErrorCardExpired or ErrorCardLostOrStolen or ErrorCreditCardTransactionFailed or ErrorDuplicateReferral or ErrorFinancingRefused or ErrorFailedToChangeSubscriptionAmount or ErrorNoPreviousTransaction or ErrorCreditCardTransactionFailedInGrace or SuccessfulCreditCardTransactionFromGrace or TransitionFromInGraceToExpired or ERROR_NO_LICENSE or ERROR_INVALID_CUSTOMER or ERROR_UNKNOWN or ERROR_PARSING_REQUEST or ERROR_NO_CUSTOMER_IN_REQUEST or ERROR_NO_CUSTOMER_NAME_IN_REQUEST or ERROR_INVALID_CUSTOMER_NAME or ERROR_BAD_BLOB</LastResponseStatus>
        <ClientName>string</ClientName>
        <FirmName>string</FirmName>
        <EmailAddress>string</EmailAddress>
        <PhoneNumber>string</PhoneNumber>
        <ConsultantIdentifier>guid</ConsultantIdentifier>
        <PromotionIdentifier>guid</PromotionIdentifier>
        <SalesRepresentativeIdentifier>guid</SalesRepresentativeIdentifier>
        <LicenseDetailIdentifiers>
          <guid>guid</guid>
          <guid>guid</guid>
        </LicenseDetailIdentifiers>
        <ClientIdentifiers>
          <guid>guid</guid>
          <guid>guid</guid>
        </ClientIdentifiers>
        <CreditCardIdentifiers>
          <guid>guid</guid>
          <guid>guid</guid>
        </CreditCardIdentifiers>
        <FirmIdentifiers>
          <guid>guid</guid>
          <guid>guid</guid>
        </FirmIdentifiers>
        <ConsentId>string</ConsentId>
        <CoreProduct>Unknown or AmicusAttorneyPremium or Credenza or AmicusWeb or OfficeToolsOnline</CoreProduct>
        <CardExpirationDate>dateTime</CardExpirationDate>
        <CardExpirationDateOperator>Unknown or Before or After or Between or On or FuzzyOn or Not</CardExpirationDateOperator>
      </searchFilter>
    </GetAmicusLicensesBySearchFilter>
  </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>
    <GetAmicusLicensesBySearchFilterResponse xmlns="http://www.credenzasoft.com/">
      <GetAmicusLicensesBySearchFilterResult>
        <CompositeLicense>
          <CredenzaLicense>string</CredenzaLicense>
          <AmicusLicense>
            <AmicusLicense>string</AmicusLicense>
            <FirmIdentifier>string</FirmIdentifier>
            <LicenseDetailIdentifier>string</LicenseDetailIdentifier>
          </AmicusLicense>
        </CompositeLicense>
        <CompositeLicense>
          <CredenzaLicense>string</CredenzaLicense>
          <AmicusLicense>
            <AmicusLicense>string</AmicusLicense>
            <FirmIdentifier>string</FirmIdentifier>
            <LicenseDetailIdentifier>string</LicenseDetailIdentifier>
          </AmicusLicense>
        </CompositeLicense>
      </GetAmicusLicensesBySearchFilterResult>
    </GetAmicusLicensesBySearchFilterResponse>
  </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>
    <GetAmicusLicensesBySearchFilter xmlns="http://www.credenzasoft.com/">
      <token>
        <ExpirationDateAndTime>dateTime</ExpirationDateAndTime>
        <Hash>string</Hash>
      </token>
      <searchFilter>
        <LicenseDetailIdentifier>guid</LicenseDetailIdentifier>
        <ValidStartDate>dateTime</ValidStartDate>
        <ValidEndDate>dateTime</ValidEndDate>
        <Type>Unknown or Demonstration or Subscription or Evaluation or InPerpetuity or Not_For_Resale or Cancelled or Financed or BulkPurchased</Type>
        <Types>
          <LicenseType>Unknown or Demonstration or Subscription or Evaluation or InPerpetuity or Not_For_Resale or Cancelled or Financed or BulkPurchased</LicenseType>
          <LicenseType>Unknown or Demonstration or Subscription or Evaluation or InPerpetuity or Not_For_Resale or Cancelled or Financed or BulkPurchased</LicenseType>
        </Types>
        <Product>Unknown or AmicusAttorney or AmicusAccounting or AmicusMobile or OutLawForOutlookForSolos or AmicusDocuments or AmicusTelephone or AmicusAssurance or OutLawForOutlookForMicroFirms or OutLawForOutlookForSmallFirms or OutLawForOutlookForLargeFirms</Product>
        <LicensedMembers>int</LicensedMembers>
        <Status>Unknown or Unverified or Active or Expired or InReadOnlyMode or InGrace or Unregistered or InsufficientLicenses or CancellationPending</Status>
        <LicenseDescription>string</LicenseDescription>
        <CreditCardIdentifier>guid</CreditCardIdentifier>
        <NameOnCreditCard>string</NameOnCreditCard>
        <ClientIdentifier>guid</ClientIdentifier>
        <FirmIdentifier>guid</FirmIdentifier>
        <LastChargedDate>dateTime</LastChargedDate>
        <CancellationDate>dateTime</CancellationDate>
        <StartUpDate>dateTime</StartUpDate>
        <Version>string</Version>
        <State>Unknown or Licensed or Unlicensed</State>
        <LastResponseStatus>Unknown or Failed or Successful or SuccessfulWithMoreInformation or InternalError or ErrorCommunicatingWithCreditCardValidationProvider or ErrorSavingToDatabase or ErrorBadCreditCardData or ErrorBadLicenseData or ErrorFailedToObtainToken or ErrorTokenHasExpired or ErrorFailedToConnectToLicensingServer or ErrorCardExpired or ErrorCardLostOrStolen or ErrorCreditCardTransactionFailed or ErrorDuplicateReferral or ErrorFinancingRefused or ErrorFailedToChangeSubscriptionAmount or ErrorNoPreviousTransaction or ErrorCreditCardTransactionFailedInGrace or SuccessfulCreditCardTransactionFromGrace or TransitionFromInGraceToExpired or ERROR_NO_LICENSE or ERROR_INVALID_CUSTOMER or ERROR_UNKNOWN or ERROR_PARSING_REQUEST or ERROR_NO_CUSTOMER_IN_REQUEST or ERROR_NO_CUSTOMER_NAME_IN_REQUEST or ERROR_INVALID_CUSTOMER_NAME or ERROR_BAD_BLOB</LastResponseStatus>
        <ClientName>string</ClientName>
        <FirmName>string</FirmName>
        <EmailAddress>string</EmailAddress>
        <PhoneNumber>string</PhoneNumber>
        <ConsultantIdentifier>guid</ConsultantIdentifier>
        <PromotionIdentifier>guid</PromotionIdentifier>
        <SalesRepresentativeIdentifier>guid</SalesRepresentativeIdentifier>
        <LicenseDetailIdentifiers>
          <guid>guid</guid>
          <guid>guid</guid>
        </LicenseDetailIdentifiers>
        <ClientIdentifiers>
          <guid>guid</guid>
          <guid>guid</guid>
        </ClientIdentifiers>
        <CreditCardIdentifiers>
          <guid>guid</guid>
          <guid>guid</guid>
        </CreditCardIdentifiers>
        <FirmIdentifiers>
          <guid>guid</guid>
          <guid>guid</guid>
        </FirmIdentifiers>
        <ConsentId>string</ConsentId>
        <CoreProduct>Unknown or AmicusAttorneyPremium or Credenza or AmicusWeb or OfficeToolsOnline</CoreProduct>
        <CardExpirationDate>dateTime</CardExpirationDate>
        <CardExpirationDateOperator>Unknown or Before or After or Between or On or FuzzyOn or Not</CardExpirationDateOperator>
      </searchFilter>
    </GetAmicusLicensesBySearchFilter>
  </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>
    <GetAmicusLicensesBySearchFilterResponse xmlns="http://www.credenzasoft.com/">
      <GetAmicusLicensesBySearchFilterResult>
        <CompositeLicense>
          <CredenzaLicense>string</CredenzaLicense>
          <AmicusLicense>
            <AmicusLicense>string</AmicusLicense>
            <FirmIdentifier>string</FirmIdentifier>
            <LicenseDetailIdentifier>string</LicenseDetailIdentifier>
          </AmicusLicense>
        </CompositeLicense>
        <CompositeLicense>
          <CredenzaLicense>string</CredenzaLicense>
          <AmicusLicense>
            <AmicusLicense>string</AmicusLicense>
            <FirmIdentifier>string</FirmIdentifier>
            <LicenseDetailIdentifier>string</LicenseDetailIdentifier>
          </AmicusLicense>
        </CompositeLicense>
      </GetAmicusLicensesBySearchFilterResult>
    </GetAmicusLicensesBySearchFilterResponse>
  </soap12:Body>
</soap12:Envelope>