EntityManagementService


Click here for a complete list of operations.

GetEntityHierarchy

Provides sufficient info to build an entity tree on the client side

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 /WebApi/AccountManagementService/EntityManagementService.asmx HTTP/1.1
Host: secure.sosonlinebackup.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "sosonlinebackup.com/GetEntityHierarchy"

<?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>
    <AuthHeader xmlns="sosonlinebackup.com">
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <GetEntityHierarchy xmlns="sosonlinebackup.com">
      <request>
        <TargetEntityID>int</TargetEntityID>
        <IncludeInactive>boolean</IncludeInactive>
        <ConnectwiseIntegratorEntityID>int</ConnectwiseIntegratorEntityID>
      </request>
    </GetEntityHierarchy>
  </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>
    <GetEntityHierarchyResponse xmlns="sosonlinebackup.com">
      <GetEntityHierarchyResult>
        <Result />
        <Entities>
          <EntityInHierarchy>
            <DistributorEntityID>int</DistributorEntityID>
            <PartnerEntityID>int</PartnerEntityID>
            <CompanyEntityID>int</CompanyEntityID>
            <EntityType>Unknown or Infrascale or Distributor or Partner or Company</EntityType>
            <IsActive>boolean</IsActive>
            <EntityID>int</EntityID>
            <EntityName>string</EntityName>
            <ParentEntityID>int</ParentEntityID>
            <ConnectWiseTicketingCompanyId>string</ConnectWiseTicketingCompanyId>
          </EntityInHierarchy>
          <EntityInHierarchy>
            <DistributorEntityID>int</DistributorEntityID>
            <PartnerEntityID>int</PartnerEntityID>
            <CompanyEntityID>int</CompanyEntityID>
            <EntityType>Unknown or Infrascale or Distributor or Partner or Company</EntityType>
            <IsActive>boolean</IsActive>
            <EntityID>int</EntityID>
            <EntityName>string</EntityName>
            <ParentEntityID>int</ParentEntityID>
            <ConnectWiseTicketingCompanyId>string</ConnectWiseTicketingCompanyId>
          </EntityInHierarchy>
        </Entities>
      </GetEntityHierarchyResult>
    </GetEntityHierarchyResponse>
  </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 /WebApi/AccountManagementService/EntityManagementService.asmx HTTP/1.1
Host: secure.sosonlinebackup.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>
    <AuthHeader xmlns="sosonlinebackup.com">
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetEntityHierarchy xmlns="sosonlinebackup.com">
      <request>
        <TargetEntityID>int</TargetEntityID>
        <IncludeInactive>boolean</IncludeInactive>
        <ConnectwiseIntegratorEntityID>int</ConnectwiseIntegratorEntityID>
      </request>
    </GetEntityHierarchy>
  </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>
    <GetEntityHierarchyResponse xmlns="sosonlinebackup.com">
      <GetEntityHierarchyResult>
        <Result />
        <Entities>
          <EntityInHierarchy>
            <DistributorEntityID>int</DistributorEntityID>
            <PartnerEntityID>int</PartnerEntityID>
            <CompanyEntityID>int</CompanyEntityID>
            <EntityType>Unknown or Infrascale or Distributor or Partner or Company</EntityType>
            <IsActive>boolean</IsActive>
            <EntityID>int</EntityID>
            <EntityName>string</EntityName>
            <ParentEntityID>int</ParentEntityID>
            <ConnectWiseTicketingCompanyId>string</ConnectWiseTicketingCompanyId>
          </EntityInHierarchy>
          <EntityInHierarchy>
            <DistributorEntityID>int</DistributorEntityID>
            <PartnerEntityID>int</PartnerEntityID>
            <CompanyEntityID>int</CompanyEntityID>
            <EntityType>Unknown or Infrascale or Distributor or Partner or Company</EntityType>
            <IsActive>boolean</IsActive>
            <EntityID>int</EntityID>
            <EntityName>string</EntityName>
            <ParentEntityID>int</ParentEntityID>
            <ConnectWiseTicketingCompanyId>string</ConnectWiseTicketingCompanyId>
          </EntityInHierarchy>
        </Entities>
      </GetEntityHierarchyResult>
    </GetEntityHierarchyResponse>
  </soap12:Body>
</soap12:Envelope>