esRemoteDesktopServices


Click here for a complete list of operations.

GetRdsCollection

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

<?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>
    <GetRdsCollection xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <collectionId>int</collectionId>
    </GetRdsCollection>
  </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>
    <GetRdsCollectionResponse xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <GetRdsCollectionResult>
        <Id>int</Id>
        <ItemId>int</ItemId>
        <Name>string</Name>
        <Description>string</Description>
        <DisplayName>string</DisplayName>
        <Servers>
          <RdsServer>
            <Id>int</Id>
            <ItemId>int</ItemId>
            <FqdName>string</FqdName>
            <Description>string</Description>
            <Address>string</Address>
            <ItemName>string</ItemName>
            <RdsCollectionId>int</RdsCollectionId>
            <ConnectionEnabled>boolean</ConnectionEnabled>
            <Status>string</Status>
            <SslAvailable>boolean</SslAvailable>
            <NetBiosName>string</NetBiosName>
          </RdsServer>
          <RdsServer>
            <Id>int</Id>
            <ItemId>int</ItemId>
            <FqdName>string</FqdName>
            <Description>string</Description>
            <Address>string</Address>
            <ItemName>string</ItemName>
            <RdsCollectionId>int</RdsCollectionId>
            <ConnectionEnabled>boolean</ConnectionEnabled>
            <Status>string</Status>
            <SslAvailable>boolean</SslAvailable>
            <NetBiosName>string</NetBiosName>
          </RdsServer>
        </Servers>
        <Settings>
          <Id>int</Id>
          <RdsCollectionId>int</RdsCollectionId>
          <DisconnectedSessionLimitMin>int</DisconnectedSessionLimitMin>
          <ActiveSessionLimitMin>int</ActiveSessionLimitMin>
          <IdleSessionLimitMin>int</IdleSessionLimitMin>
          <BrokenConnectionAction>string</BrokenConnectionAction>
          <AutomaticReconnectionEnabled>boolean</AutomaticReconnectionEnabled>
          <TemporaryFoldersDeletedOnExit>boolean</TemporaryFoldersDeletedOnExit>
          <TemporaryFoldersPerSession>boolean</TemporaryFoldersPerSession>
          <ClientDeviceRedirectionOptions>string</ClientDeviceRedirectionOptions>
          <ClientPrinterRedirected>boolean</ClientPrinterRedirected>
          <ClientPrinterAsDefault>boolean</ClientPrinterAsDefault>
          <RDEasyPrintDriverEnabled>boolean</RDEasyPrintDriverEnabled>
          <MaxRedirectedMonitors>int</MaxRedirectedMonitors>
          <SecurityLayer>string</SecurityLayer>
          <EncryptionLevel>string</EncryptionLevel>
          <AuthenticateUsingNLA>boolean</AuthenticateUsingNLA>
        </Settings>
        <CustomSettings>
          <RdsCollectionCustomSetting>
            <Id>int</Id>
            <RdsCollectionId>int</RdsCollectionId>
            <Value>string</Value>
            <RdpSetting xsi:nil="true" />
          </RdsCollectionCustomSetting>
          <RdsCollectionCustomSetting>
            <Id>int</Id>
            <RdsCollectionId>int</RdsCollectionId>
            <Value>string</Value>
            <RdpSetting xsi:nil="true" />
          </RdsCollectionCustomSetting>
        </CustomSettings>
      </GetRdsCollectionResult>
    </GetRdsCollectionResponse>
  </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 /esRemoteDesktopServices.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>
    <GetRdsCollection xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <collectionId>int</collectionId>
    </GetRdsCollection>
  </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>
    <GetRdsCollectionResponse xmlns="http://smbsaas/MSPControl/enterpriseserver">
      <GetRdsCollectionResult>
        <Id>int</Id>
        <ItemId>int</ItemId>
        <Name>string</Name>
        <Description>string</Description>
        <DisplayName>string</DisplayName>
        <Servers>
          <RdsServer>
            <Id>int</Id>
            <ItemId>int</ItemId>
            <FqdName>string</FqdName>
            <Description>string</Description>
            <Address>string</Address>
            <ItemName>string</ItemName>
            <RdsCollectionId>int</RdsCollectionId>
            <ConnectionEnabled>boolean</ConnectionEnabled>
            <Status>string</Status>
            <SslAvailable>boolean</SslAvailable>
            <NetBiosName>string</NetBiosName>
          </RdsServer>
          <RdsServer>
            <Id>int</Id>
            <ItemId>int</ItemId>
            <FqdName>string</FqdName>
            <Description>string</Description>
            <Address>string</Address>
            <ItemName>string</ItemName>
            <RdsCollectionId>int</RdsCollectionId>
            <ConnectionEnabled>boolean</ConnectionEnabled>
            <Status>string</Status>
            <SslAvailable>boolean</SslAvailable>
            <NetBiosName>string</NetBiosName>
          </RdsServer>
        </Servers>
        <Settings>
          <Id>int</Id>
          <RdsCollectionId>int</RdsCollectionId>
          <DisconnectedSessionLimitMin>int</DisconnectedSessionLimitMin>
          <ActiveSessionLimitMin>int</ActiveSessionLimitMin>
          <IdleSessionLimitMin>int</IdleSessionLimitMin>
          <BrokenConnectionAction>string</BrokenConnectionAction>
          <AutomaticReconnectionEnabled>boolean</AutomaticReconnectionEnabled>
          <TemporaryFoldersDeletedOnExit>boolean</TemporaryFoldersDeletedOnExit>
          <TemporaryFoldersPerSession>boolean</TemporaryFoldersPerSession>
          <ClientDeviceRedirectionOptions>string</ClientDeviceRedirectionOptions>
          <ClientPrinterRedirected>boolean</ClientPrinterRedirected>
          <ClientPrinterAsDefault>boolean</ClientPrinterAsDefault>
          <RDEasyPrintDriverEnabled>boolean</RDEasyPrintDriverEnabled>
          <MaxRedirectedMonitors>int</MaxRedirectedMonitors>
          <SecurityLayer>string</SecurityLayer>
          <EncryptionLevel>string</EncryptionLevel>
          <AuthenticateUsingNLA>boolean</AuthenticateUsingNLA>
        </Settings>
        <CustomSettings>
          <RdsCollectionCustomSetting>
            <Id>int</Id>
            <RdsCollectionId>int</RdsCollectionId>
            <Value>string</Value>
            <RdpSetting xsi:nil="true" />
          </RdsCollectionCustomSetting>
          <RdsCollectionCustomSetting>
            <Id>int</Id>
            <RdsCollectionId>int</RdsCollectionId>
            <Value>string</Value>
            <RdpSetting xsi:nil="true" />
          </RdsCollectionCustomSetting>
        </CustomSettings>
      </GetRdsCollectionResult>
    </GetRdsCollectionResponse>
  </soap12:Body>
</soap12:Envelope>