esServers


Click here for a complete list of operations.

GetPackageIPAddresses

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 /esServers.asmx HTTP/1.1
Host: api.mspcontrol.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://smbsaas/MSPControl/enterpriseserver/GetPackageIPAddresses"

<?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>
    <GetPackageIPAddresses xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <packageId>int</packageId>
      <orgId>int</orgId>
      <pool>None or General or WebSites or VpsExternalNetwork or VpsManagementNetwork or PhoneNumbers</pool>
      <filterColumn>string</filterColumn>
      <filterValue>string</filterValue>
      <sortColumn>string</sortColumn>
      <startRow>int</startRow>
      <maximumRows>int</maximumRows>
      <recursive>boolean</recursive>
    </GetPackageIPAddresses>
  </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>
    <GetPackageIPAddressesResponse xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <GetPackageIPAddressesResult>
        <Items>
          <PackageIPAddress>
            <PackageAddressID>int</PackageAddressID>
            <AddressID>int</AddressID>
            <ExternalIP>string</ExternalIP>
            <InternalIP>string</InternalIP>
            <SubnetMask>string</SubnetMask>
            <DefaultGateway>string</DefaultGateway>
            <ItemId>int</ItemId>
            <ItemName>string</ItemName>
            <IsPrimary>boolean</IsPrimary>
            <PackageId>int</PackageId>
            <PackageName>string</PackageName>
            <UserId>int</UserId>
            <UserName>string</UserName>
          </PackageIPAddress>
          <PackageIPAddress>
            <PackageAddressID>int</PackageAddressID>
            <AddressID>int</AddressID>
            <ExternalIP>string</ExternalIP>
            <InternalIP>string</InternalIP>
            <SubnetMask>string</SubnetMask>
            <DefaultGateway>string</DefaultGateway>
            <ItemId>int</ItemId>
            <ItemName>string</ItemName>
            <IsPrimary>boolean</IsPrimary>
            <PackageId>int</PackageId>
            <PackageName>string</PackageName>
            <UserId>int</UserId>
            <UserName>string</UserName>
          </PackageIPAddress>
        </Items>
        <Count>int</Count>
      </GetPackageIPAddressesResult>
    </GetPackageIPAddressesResponse>
  </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 /esServers.asmx HTTP/1.1
Host: api.mspcontrol.org
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>
    <GetPackageIPAddresses xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <packageId>int</packageId>
      <orgId>int</orgId>
      <pool>None or General or WebSites or VpsExternalNetwork or VpsManagementNetwork or PhoneNumbers</pool>
      <filterColumn>string</filterColumn>
      <filterValue>string</filterValue>
      <sortColumn>string</sortColumn>
      <startRow>int</startRow>
      <maximumRows>int</maximumRows>
      <recursive>boolean</recursive>
    </GetPackageIPAddresses>
  </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>
    <GetPackageIPAddressesResponse xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <GetPackageIPAddressesResult>
        <Items>
          <PackageIPAddress>
            <PackageAddressID>int</PackageAddressID>
            <AddressID>int</AddressID>
            <ExternalIP>string</ExternalIP>
            <InternalIP>string</InternalIP>
            <SubnetMask>string</SubnetMask>
            <DefaultGateway>string</DefaultGateway>
            <ItemId>int</ItemId>
            <ItemName>string</ItemName>
            <IsPrimary>boolean</IsPrimary>
            <PackageId>int</PackageId>
            <PackageName>string</PackageName>
            <UserId>int</UserId>
            <UserName>string</UserName>
          </PackageIPAddress>
          <PackageIPAddress>
            <PackageAddressID>int</PackageAddressID>
            <AddressID>int</AddressID>
            <ExternalIP>string</ExternalIP>
            <InternalIP>string</InternalIP>
            <SubnetMask>string</SubnetMask>
            <DefaultGateway>string</DefaultGateway>
            <ItemId>int</ItemId>
            <ItemName>string</ItemName>
            <IsPrimary>boolean</IsPrimary>
            <PackageId>int</PackageId>
            <PackageName>string</PackageName>
            <UserId>int</UserId>
            <UserName>string</UserName>
          </PackageIPAddress>
        </Items>
        <Count>int</Count>
      </GetPackageIPAddressesResult>
    </GetPackageIPAddressesResponse>
  </soap12:Body>
</soap12:Envelope>