LiveUpdateService Web Service

LiveUpdateService

Click here for a complete list of operations.

GetLiveUpdatesForFirm

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 /LiveUpdate.asmx HTTP/1.1
Host: liveupdate.cloud.aderant.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://liveupdate.cloud.aderant.com/GetLiveUpdatesForFirm"

<?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://liveupdate.cloud.aderant.com/">
      <Key>string</Key>
      <FirmRegistrationKey>string</FirmRegistrationKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetLiveUpdatesForFirm xmlns="http://liveupdate.cloud.aderant.com/">
      <firmDatabase>
        <FirmDatabaseID>int</FirmDatabaseID>
        <FirmSerialNumber>int</FirmSerialNumber>
        <DatabaseName>string</DatabaseName>
        <Version>int</Version>
        <ActualVersion>int</ActualVersion>
        <LastUsed>dateTime</LastUsed>
        <Disabled>dateTime</Disabled>
        <AlertWarningDays>int</AlertWarningDays>
        <LastProcessedByUpdateCreator>dateTime</LastProcessedByUpdateCreator>
        <LastRulesetsUpdated>dateTime</LastRulesetsUpdated>
        <RulesVersionHash>string</RulesVersionHash>
        <LiveUpdateHash>string</LiveUpdateHash>
        <LastLiveUpdateLogEntryDate>dateTime</LastLiveUpdateLogEntryDate>
      </firmDatabase>
    </GetLiveUpdatesForFirm>
  </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>
    <GetLiveUpdatesForFirmResponse xmlns="http://liveupdate.cloud.aderant.com/">
      <GetLiveUpdatesForFirmResult>
        <LiveUpdateRecord>
          <LiveUpdateID>int</LiveUpdateID>
          <ZipFileName>string</ZipFileName>
          <DatePosted>dateTime</DatePosted>
          <DescriptorID>int</DescriptorID>
          <Title>string</Title>
          <Description>string</Description>
          <SpecialInstructions>boolean</SpecialInstructions>
          <OptionalUpdate>boolean</OptionalUpdate>
          <SHAHash>string</SHAHash>
          <Deleted>boolean</Deleted>
          <OnHold>boolean</OnHold>
          <Revoked>boolean</Revoked>
          <InvoiceCode>int</InvoiceCode>
          <DateAdded>dateTime</DateAdded>
          <DbVersion>int</DbVersion>
          <HideFromList>boolean</HideFromList>
          <LiveUpdateVersion>int</LiveUpdateVersion>
        </LiveUpdateRecord>
        <LiveUpdateRecord>
          <LiveUpdateID>int</LiveUpdateID>
          <ZipFileName>string</ZipFileName>
          <DatePosted>dateTime</DatePosted>
          <DescriptorID>int</DescriptorID>
          <Title>string</Title>
          <Description>string</Description>
          <SpecialInstructions>boolean</SpecialInstructions>
          <OptionalUpdate>boolean</OptionalUpdate>
          <SHAHash>string</SHAHash>
          <Deleted>boolean</Deleted>
          <OnHold>boolean</OnHold>
          <Revoked>boolean</Revoked>
          <InvoiceCode>int</InvoiceCode>
          <DateAdded>dateTime</DateAdded>
          <DbVersion>int</DbVersion>
          <HideFromList>boolean</HideFromList>
          <LiveUpdateVersion>int</LiveUpdateVersion>
        </LiveUpdateRecord>
      </GetLiveUpdatesForFirmResult>
    </GetLiveUpdatesForFirmResponse>
  </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 /LiveUpdate.asmx HTTP/1.1
Host: liveupdate.cloud.aderant.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:Header>
    <AuthenticationHeader xmlns="http://liveupdate.cloud.aderant.com/">
      <Key>string</Key>
      <FirmRegistrationKey>string</FirmRegistrationKey>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <GetLiveUpdatesForFirm xmlns="http://liveupdate.cloud.aderant.com/">
      <firmDatabase>
        <FirmDatabaseID>int</FirmDatabaseID>
        <FirmSerialNumber>int</FirmSerialNumber>
        <DatabaseName>string</DatabaseName>
        <Version>int</Version>
        <ActualVersion>int</ActualVersion>
        <LastUsed>dateTime</LastUsed>
        <Disabled>dateTime</Disabled>
        <AlertWarningDays>int</AlertWarningDays>
        <LastProcessedByUpdateCreator>dateTime</LastProcessedByUpdateCreator>
        <LastRulesetsUpdated>dateTime</LastRulesetsUpdated>
        <RulesVersionHash>string</RulesVersionHash>
        <LiveUpdateHash>string</LiveUpdateHash>
        <LastLiveUpdateLogEntryDate>dateTime</LastLiveUpdateLogEntryDate>
      </firmDatabase>
    </GetLiveUpdatesForFirm>
  </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>
    <GetLiveUpdatesForFirmResponse xmlns="http://liveupdate.cloud.aderant.com/">
      <GetLiveUpdatesForFirmResult>
        <LiveUpdateRecord>
          <LiveUpdateID>int</LiveUpdateID>
          <ZipFileName>string</ZipFileName>
          <DatePosted>dateTime</DatePosted>
          <DescriptorID>int</DescriptorID>
          <Title>string</Title>
          <Description>string</Description>
          <SpecialInstructions>boolean</SpecialInstructions>
          <OptionalUpdate>boolean</OptionalUpdate>
          <SHAHash>string</SHAHash>
          <Deleted>boolean</Deleted>
          <OnHold>boolean</OnHold>
          <Revoked>boolean</Revoked>
          <InvoiceCode>int</InvoiceCode>
          <DateAdded>dateTime</DateAdded>
          <DbVersion>int</DbVersion>
          <HideFromList>boolean</HideFromList>
          <LiveUpdateVersion>int</LiveUpdateVersion>
        </LiveUpdateRecord>
        <LiveUpdateRecord>
          <LiveUpdateID>int</LiveUpdateID>
          <ZipFileName>string</ZipFileName>
          <DatePosted>dateTime</DatePosted>
          <DescriptorID>int</DescriptorID>
          <Title>string</Title>
          <Description>string</Description>
          <SpecialInstructions>boolean</SpecialInstructions>
          <OptionalUpdate>boolean</OptionalUpdate>
          <SHAHash>string</SHAHash>
          <Deleted>boolean</Deleted>
          <OnHold>boolean</OnHold>
          <Revoked>boolean</Revoked>
          <InvoiceCode>int</InvoiceCode>
          <DateAdded>dateTime</DateAdded>
          <DbVersion>int</DbVersion>
          <HideFromList>boolean</HideFromList>
          <LiveUpdateVersion>int</LiveUpdateVersion>
        </LiveUpdateRecord>
      </GetLiveUpdatesForFirmResult>
    </GetLiveUpdatesForFirmResponse>
  </soap12:Body>
</soap12:Envelope>