BackupPolicyManagementService


Click here for a complete list of operations.

GetEntityPolicies

Returns all defined entity policies (paged output). Set targetEntityId=0 to manage your entity, otherwise you must send sub-entity ID.

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

<?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>
    <GetEntityPolicies xmlns="sosonlinebackup.com">
      <pageIndex>int</pageIndex>
      <pageSize>int</pageSize>
      <targetEntityId>int</targetEntityId>
    </GetEntityPolicies>
  </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>
    <GetEntityPoliciesResponse xmlns="sosonlinebackup.com">
      <GetEntityPoliciesResult>
        <Result />
        <EntityPolicies>
          <EntityPolicy>
            <EntityBackupPolicyID>int</EntityBackupPolicyID>
            <TargetEntityID>int</TargetEntityID>
            <PolicyName>string</PolicyName>
            <DateCreated>dateTime</DateCreated>
            <BackupSet xsi:nil="true" />
            <Schedule xsi:nil="true" />
            <RunAs xsi:nil="true" />
            <Options xsi:nil="true" />
            <ScannerFileFilters xsi:nil="true" />
            <UseSystemAccountForScanningUserPersonalFolders>boolean</UseSystemAccountForScanningUserPersonalFolders>
            <LiveProtectWholeBackupSet>boolean</LiveProtectWholeBackupSet>
          </EntityPolicy>
          <EntityPolicy>
            <EntityBackupPolicyID>int</EntityBackupPolicyID>
            <TargetEntityID>int</TargetEntityID>
            <PolicyName>string</PolicyName>
            <DateCreated>dateTime</DateCreated>
            <BackupSet xsi:nil="true" />
            <Schedule xsi:nil="true" />
            <RunAs xsi:nil="true" />
            <Options xsi:nil="true" />
            <ScannerFileFilters xsi:nil="true" />
            <UseSystemAccountForScanningUserPersonalFolders>boolean</UseSystemAccountForScanningUserPersonalFolders>
            <LiveProtectWholeBackupSet>boolean</LiveProtectWholeBackupSet>
          </EntityPolicy>
        </EntityPolicies>
        <TotalRecords>int</TotalRecords>
      </GetEntityPoliciesResult>
    </GetEntityPoliciesResponse>
  </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/BackupPolicyManagementService.asmx HTTP/1.1
Host: secure-sandbox.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>
    <GetEntityPolicies xmlns="sosonlinebackup.com">
      <pageIndex>int</pageIndex>
      <pageSize>int</pageSize>
      <targetEntityId>int</targetEntityId>
    </GetEntityPolicies>
  </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>
    <GetEntityPoliciesResponse xmlns="sosonlinebackup.com">
      <GetEntityPoliciesResult>
        <Result />
        <EntityPolicies>
          <EntityPolicy>
            <EntityBackupPolicyID>int</EntityBackupPolicyID>
            <TargetEntityID>int</TargetEntityID>
            <PolicyName>string</PolicyName>
            <DateCreated>dateTime</DateCreated>
            <BackupSet xsi:nil="true" />
            <Schedule xsi:nil="true" />
            <RunAs xsi:nil="true" />
            <Options xsi:nil="true" />
            <ScannerFileFilters xsi:nil="true" />
            <UseSystemAccountForScanningUserPersonalFolders>boolean</UseSystemAccountForScanningUserPersonalFolders>
            <LiveProtectWholeBackupSet>boolean</LiveProtectWholeBackupSet>
          </EntityPolicy>
          <EntityPolicy>
            <EntityBackupPolicyID>int</EntityBackupPolicyID>
            <TargetEntityID>int</TargetEntityID>
            <PolicyName>string</PolicyName>
            <DateCreated>dateTime</DateCreated>
            <BackupSet xsi:nil="true" />
            <Schedule xsi:nil="true" />
            <RunAs xsi:nil="true" />
            <Options xsi:nil="true" />
            <ScannerFileFilters xsi:nil="true" />
            <UseSystemAccountForScanningUserPersonalFolders>boolean</UseSystemAccountForScanningUserPersonalFolders>
            <LiveProtectWholeBackupSet>boolean</LiveProtectWholeBackupSet>
          </EntityPolicy>
        </EntityPolicies>
        <TotalRecords>int</TotalRecords>
      </GetEntityPoliciesResult>
    </GetEntityPoliciesResponse>
  </soap12:Body>
</soap12:Envelope>