Reference for GetLicenseInfo

Url: license/licenseInfo

HTTP Method: GET

Message direction	Format	Body
Request	XML	Example,Schema
Response	XML	Example,Schema

The following is an example request XML body:

No Xml request body for this method. False

The following is an example response XML body:

<?xml version="1.0" encoding="utf-16"?>
<licenseInfo xmlns="http://apprecovery.com/management/api/2010/05">
  <agentLicenseInfos>
    <agentLicenseInfo>
      <expirationPeriod>P428DT10H30M12.3S</expirationPeriod>
      <id>String content</id>
      <isVirtual>true</isVirtual>
      <licenseStates i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
      <licenseType>Trial</licenseType>
    </agentLicenseInfo>
    <agentLicenseInfo>
      <expirationPeriod>P428DT10H30M12.3S</expirationPeriod>
      <id>String content</id>
      <isVirtual>true</isVirtual>
      <licenseStates i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
      <licenseType>Trial</licenseType>
    </agentLicenseInfo>
  </agentLicenseInfos>
  <coreLicenseInfo>
    <capacityPool>2147483647</capacityPool>
    <capacityPoolConsumption>1.26743233E+15</capacityPoolConsumption>
    <capacityPoolConsumptionByThisCore>1.26743233E+15</capacityPoolConsumptionByThisCore>
    <gracePeriod>P428DT10H30M12.3S</gracePeriod>
    <groupKey>String content</groupKey>
    <groupLicenseConsumption>2147483647</groupLicenseConsumption>
    <groupVirtualMachineLicenseConsumption>2147483647</groupVirtualMachineLicenseConsumption>
    <isCapacityLicense>true</isCapacityLicense>
    <isCapacityPoolEnabled>true</isCapacityPoolEnabled>
    <isMixedPoolEnabled>true</isMixedPoolEnabled>
    <isPhysicalPoolEnabled>true</isPhysicalPoolEnabled>
    <isVirtualMachinePoolEnabled>true</isVirtualMachinePoolEnabled>
    <isVirtualPoolEnabled>true</isVirtualPoolEnabled>
    <lastContactTimestamp>1999-05-31T11:20:00</lastContactTimestamp>
    <licenseNumbers>
      <licenseNumberInfos>
        <IsExtension>true</IsExtension>
        <LicenseNumber>String content</LicenseNumber>
        <ProductType>String content</ProductType>
        <ServiceTag>String content</ServiceTag>
      </licenseNumberInfos>
      <licenseNumberInfos>
        <IsExtension>true</IsExtension>
        <LicenseNumber>String content</LicenseNumber>
        <ProductType>String content</ProductType>
        <ServiceTag>String content</ServiceTag>
      </licenseNumberInfos>
    </licenseNumbers>
    <licensePoolSize>2147483647</licensePoolSize>
    <licensePortalResponse>NoPhoneHomeSessionPerformed</licensePortalResponse>
    <licensePortalResponseMessage>String content</licensePortalResponseMessage>
    <licenseStates i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
    <licenseTimeLeft>P428DT10H30M12.3S</licenseTimeLeft>
    <licenseType>Trial</licenseType>
    <nextContactTimestamp>1999-05-31T11:20:00</nextContactTimestamp>
    <physicalGroupLicenseConsumption>2147483647</physicalGroupLicenseConsumption>
    <physicalPoolSize>2147483647</physicalPoolSize>
    <productType>Unknown</productType>
    <protectedMachinesCount>2147483647</protectedMachinesCount>
    <protectedOnlyVirtualMachinesCount>2147483647</protectedOnlyVirtualMachinesCount>
    <protectedPhysicalMachinesCount>2147483647</protectedPhysicalMachinesCount>
    <protectedVirtualMachinesCount>2147483647</protectedVirtualMachinesCount>
    <virtualGroupLicenseConsumption>2147483647</virtualGroupLicenseConsumption>
    <virtualMachinePoolSize>2147483647</virtualMachinePoolSize>
    <virtualPoolSize>2147483647</virtualPoolSize>
  </coreLicenseInfo>
</licenseInfo>

The following is the request XML Schema:

The request body is empty.

The following is the response XML Schema:

<?xml version="1.0" encoding="utf-16"?>
<Schemas>
  <xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="anyType" nillable="true" type="xs:anyType" />
    <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
    <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
    <xs:element name="boolean" nillable="true" type="xs:boolean" />
    <xs:element name="byte" nillable="true" type="xs:byte" />
    <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
    <xs:element name="decimal" nillable="true" type="xs:decimal" />
    <xs:element name="double" nillable="true" type="xs:double" />
    <xs:element name="float" nillable="true" type="xs:float" />
    <xs:element name="int" nillable="true" type="xs:int" />
    <xs:element name="long" nillable="true" type="xs:long" />
    <xs:element name="QName" nillable="true" type="xs:QName" />
    <xs:element name="short" nillable="true" type="xs:short" />
    <xs:element name="string" nillable="true" type="xs:string" />
    <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
    <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
    <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
    <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
    <xs:element name="char" nillable="true" type="tns:char" />
    <xs:simpleType name="char">
      <xs:restriction base="xs:int" />
    </xs:simpleType>
    <xs:element name="duration" nillable="true" type="tns:duration" />
    <xs:simpleType name="duration">
      <xs:restriction base="xs:duration">
        <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
        <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
        <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="guid" nillable="true" type="tns:guid" />
    <xs:simpleType name="guid">
      <xs:restriction base="xs:string">
        <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
      </xs:restriction>
    </xs:simpleType>
    <xs:attribute name="FactoryType" type="xs:QName" />
    <xs:attribute name="Id" type="xs:ID" />
    <xs:attribute name="Ref" type="xs:IDREF" />
  </xs:schema>
  <xs:schema xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:tns="http://apprecovery.com/management/api/2010/05" elementFormDefault="qualified" targetNamespace="http://apprecovery.com/management/api/2010/05" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
    <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Licensing" />
    <xs:import namespace="http://schemas.datacontract.org/2004/07/AppAssure.LicensePortal.PhoneHome.WebServices.DataContracts" />
    <xs:complexType name="licenseInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="agentLicenseInfos" nillable="true" type="tns:agentLicenseInfosCollection" />
        <xs:element minOccurs="0" name="coreLicenseInfo" nillable="true" type="tns:coreLicenseInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="licenseInfo" nillable="true" type="tns:licenseInfo" />
    <xs:complexType name="agentLicenseInfosCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="agentLicenseInfo" nillable="true" type="tns:agentLicenseInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="agentLicenseInfosCollection" nillable="true" type="tns:agentLicenseInfosCollection" />
    <xs:complexType name="agentLicenseInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="expirationPeriod" nillable="true" type="ser:duration" />
        <xs:element minOccurs="0" name="id" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="isVirtual" type="xs:boolean" />
        <xs:element minOccurs="0" name="licenseStates" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Licensing" type="q1:AgentLicenseStates" />
        <xs:element minOccurs="0" name="licenseType" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Licensing" type="q2:AgentLicenseType" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="agentLicenseInfo" nillable="true" type="tns:agentLicenseInfo" />
    <xs:complexType name="coreLicenseInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="capacityPool" type="xs:int" />
        <xs:element minOccurs="0" name="capacityPoolConsumption" type="xs:double" />
        <xs:element minOccurs="0" name="capacityPoolConsumptionByThisCore" type="xs:double" />
        <xs:element minOccurs="0" name="gracePeriod" nillable="true" type="ser:duration">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="groupKey" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="groupLicenseConsumption" type="xs:int" />
        <xs:element minOccurs="0" name="groupVirtualMachineLicenseConsumption" type="xs:int" />
        <xs:element minOccurs="0" name="isCapacityLicense" type="xs:boolean" />
        <xs:element minOccurs="0" name="isCapacityPoolEnabled" type="xs:boolean" />
        <xs:element minOccurs="0" name="isMixedPoolEnabled" type="xs:boolean" />
        <xs:element minOccurs="0" name="isPhysicalPoolEnabled" type="xs:boolean" />
        <xs:element minOccurs="0" name="isVirtualMachinePoolEnabled" type="xs:boolean" />
        <xs:element minOccurs="0" name="isVirtualPoolEnabled" type="xs:boolean" />
        <xs:element minOccurs="0" name="lastContactTimestamp" type="xs:dateTime" />
        <xs:element minOccurs="0" name="licenseNumbers" nillable="true" type="tns:licenseNumberInfos" />
        <xs:element minOccurs="0" name="licensePoolSize" type="xs:int" />
        <xs:element minOccurs="0" name="licensePortalResponse" xmlns:q3="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Licensing" type="q3:PhoneHomeSessionResult" />
        <xs:element minOccurs="0" name="licensePortalResponseMessage" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="licenseStates" xmlns:q4="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Licensing" type="q4:CoreLicenseStates" />
        <xs:element minOccurs="0" name="licenseTimeLeft" nillable="true" type="ser:duration">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="licenseType" xmlns:q5="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Licensing" type="q5:LicenseType" />
        <xs:element minOccurs="0" name="nextContactTimestamp" type="xs:dateTime" />
        <xs:element minOccurs="0" name="physicalGroupLicenseConsumption" type="xs:int" />
        <xs:element minOccurs="0" name="physicalPoolSize" type="xs:int" />
        <xs:element minOccurs="0" name="productType" xmlns:q6="http://schemas.datacontract.org/2004/07/AppAssure.LicensePortal.PhoneHome.WebServices.DataContracts" type="q6:ProductType" />
        <xs:element minOccurs="0" name="protectedMachinesCount" type="xs:int" />
        <xs:element minOccurs="0" name="protectedOnlyVirtualMachinesCount" type="xs:int" />
        <xs:element minOccurs="0" name="protectedPhysicalMachinesCount" type="xs:int" />
        <xs:element minOccurs="0" name="protectedVirtualMachinesCount" type="xs:int" />
        <xs:element minOccurs="0" name="virtualGroupLicenseConsumption" type="xs:int" />
        <xs:element minOccurs="0" name="virtualMachinePoolSize" type="xs:int" />
        <xs:element minOccurs="0" name="virtualPoolSize" type="xs:int" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="coreLicenseInfo" nillable="true" type="tns:coreLicenseInfo" />
    <xs:complexType name="licenseNumberInfos">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="licenseNumberInfos" nillable="true" type="tns:licenseNumberInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="licenseNumberInfos" nillable="true" type="tns:licenseNumberInfos" />
    <xs:complexType name="licenseNumberInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="IsExtension" type="xs:boolean" />
        <xs:element minOccurs="0" name="LicenseNumber" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="ProductType" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="ServiceTag" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="licenseNumberInfo" nillable="true" type="tns:licenseNumberInfo" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Licensing" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Licensing" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
    <xs:simpleType name="AgentLicenseStates">
      <xs:list>
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="NotRegistered">
              <xs:annotation>
                <xs:appinfo>
                  <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</EnumerationValue>
                </xs:appinfo>
              </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="Active">
              <xs:annotation>
                <xs:appinfo>
                  <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
                </xs:appinfo>
              </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="Inactive">
              <xs:annotation>
                <xs:appinfo>
                  <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
                </xs:appinfo>
              </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="LicenseExpired">
              <xs:annotation>
                <xs:appinfo>
                  <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
                </xs:appinfo>
              </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="TrialExpired">
              <xs:annotation>
                <xs:appinfo>
                  <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue>
                </xs:appinfo>
              </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="Blocked">
              <xs:annotation>
                <xs:appinfo>
                  <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">16</EnumerationValue>
                </xs:appinfo>
              </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="BlockedByAppAssure">
              <xs:annotation>
                <xs:appinfo>
                  <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">32</EnumerationValue>
                </xs:appinfo>
              </xs:annotation>
            </xs:enumeration>
          </xs:restriction>
        </xs:simpleType>
      </xs:list>
    </xs:simpleType>
    <xs:element name="AgentLicenseStates" nillable="true" type="tns:AgentLicenseStates" />
    <xs:simpleType name="AgentLicenseType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Trial" />
        <xs:enumeration value="Subscription" />
        <xs:enumeration value="Enterprise" />
        <xs:enumeration value="FreeOfCharge" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="AgentLicenseType" nillable="true" type="tns:AgentLicenseType" />
    <xs:simpleType name="PhoneHomeSessionResult">
      <xs:restriction base="xs:string">
        <xs:enumeration value="NoPhoneHomeSessionPerformed" />
        <xs:enumeration value="InProgress" />
        <xs:enumeration value="Success" />
        <xs:enumeration value="FailedCoreHeartbeat" />
        <xs:enumeration value="FailedAgentsHeartbeat" />
        <xs:enumeration value="FailedToConnect" />
        <xs:enumeration value="FailedToPerformSession" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="PhoneHomeSessionResult" nillable="true" type="tns:PhoneHomeSessionResult" />
    <xs:simpleType name="CoreLicenseStates">
      <xs:list>
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="Active" />
            <xs:enumeration value="GracePeriodExpired" />
            <xs:enumeration value="LicenseKeyExpired" />
            <xs:enumeration value="Blocked" />
          </xs:restriction>
        </xs:simpleType>
      </xs:list>
    </xs:simpleType>
    <xs:element name="CoreLicenseStates" nillable="true" type="tns:CoreLicenseStates" />
    <xs:simpleType name="LicenseType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Trial" />
        <xs:enumeration value="Subscription" />
        <xs:enumeration value="Enterprise" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="LicenseType" nillable="true" type="tns:LicenseType" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/AppAssure.LicensePortal.PhoneHome.WebServices.DataContracts" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/AppAssure.LicensePortal.PhoneHome.WebServices.DataContracts" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="ProductType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Unknown" />
        <xs:enumeration value="Software" />
        <xs:enumeration value="Javelin" />
        <xs:enumeration value="Brimstone" />
        <xs:enumeration value="Essentials" />
        <xs:enumeration value="SoftwareCapacity" />
        <xs:enumeration value="DLVRTX" />
        <xs:enumeration value="DL1300" />
        <xs:enumeration value="SoftwareMSP" />
        <xs:enumeration value="RRVA" />
        <xs:enumeration value="Foglight" />
        <xs:enumeration value="VMOnly" />
        <xs:enumeration value="FrontEndMSPCapacity" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="ProductType" nillable="true" type="tns:ProductType" />
  </xs:schema>
</Schemas>