esServers


Click here for a complete list of operations.

GetServerByName

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

<?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>
    <GetServerByName xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <serverName>string</serverName>
    </GetServerByName>
  </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>
    <GetServerByNameResponse xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <GetServerByNameResult>
        <PrimaryGroupId>int</PrimaryGroupId>
        <ADRootDomain>string</ADRootDomain>
        <ADAuthenticationType>string</ADAuthenticationType>
        <ADUsername>string</ADUsername>
        <ADPassword>string</ADPassword>
        <ServerId>int</ServerId>
        <ServerName>string</ServerName>
        <ServerUrl>string</ServerUrl>
        <Comments>string</Comments>
        <Password>string</Password>
        <VirtualServer>boolean</VirtualServer>
        <InstantDomainAlias>string</InstantDomainAlias>
        <ADEnabled>boolean</ADEnabled>
      </GetServerByNameResult>
    </GetServerByNameResponse>
  </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>
    <GetServerByName xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <serverName>string</serverName>
    </GetServerByName>
  </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>
    <GetServerByNameResponse xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <GetServerByNameResult>
        <PrimaryGroupId>int</PrimaryGroupId>
        <ADRootDomain>string</ADRootDomain>
        <ADAuthenticationType>string</ADAuthenticationType>
        <ADUsername>string</ADUsername>
        <ADPassword>string</ADPassword>
        <ServerId>int</ServerId>
        <ServerName>string</ServerName>
        <ServerUrl>string</ServerUrl>
        <Comments>string</Comments>
        <Password>string</Password>
        <VirtualServer>boolean</VirtualServer>
        <InstantDomainAlias>string</InstantDomainAlias>
        <ADEnabled>boolean</ADEnabled>
      </GetServerByNameResult>
    </GetServerByNameResponse>
  </soap12:Body>
</soap12:Envelope>