BackupPolicyManagementService


Click here for a complete list of operations.

DeleteEntityPolicy

Deletes target entity policy. Returns deleted entity policy. 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/DeleteEntityPolicy"

<?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>
    <DeleteEntityPolicy xmlns="sosonlinebackup.com">
      <entityPolicyID>int</entityPolicyID>
      <targetEntityId>int</targetEntityId>
      <unassignAccounts>boolean</unassignAccounts>
    </DeleteEntityPolicy>
  </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>
    <DeleteEntityPolicyResponse xmlns="sosonlinebackup.com">
      <DeleteEntityPolicyResult>
        <Result />
        <EntityPolicy>
          <EntityBackupPolicyID>int</EntityBackupPolicyID>
          <TargetEntityID>int</TargetEntityID>
          <PolicyName>string</PolicyName>
          <DateCreated>dateTime</DateCreated>
          <BackupSet>
            <ScannerMode>ScanAll or ScanPersonal or DontScan</ScannerMode>
            <BackupDocuments>boolean</BackupDocuments>
            <BackupImages>boolean</BackupImages>
            <BackupMusic>boolean</BackupMusic>
            <BackupVideo>boolean</BackupVideo>
            <BackupCustom>boolean</BackupCustom>
            <CustomFileTypes>string</CustomFileTypes>
            <ExcludeFileTypes>string</ExcludeFileTypes>
          </BackupSet>
          <Schedule>
            <ScheduleType>Monthly or Weekly or Daily or Hourly</ScheduleType>
            <ScheduledTime>dateTime</ScheduledTime>
            <ScheduledDayOfTheMonth>unsignedByte</ScheduledDayOfTheMonth>
            <ScheduledDayOfTheWeek>Sunday or Monday or Tuesday or Wednesday or Thursday or Friday or Saturday</ScheduledDayOfTheWeek>
            <ScheduledHoursBetweenRuns>unsignedByte</ScheduledHoursBetweenRuns>
            <ScheduledEndTime>dateTime</ScheduledEndTime>
            <UseEndTime>boolean</UseEndTime>
          </Schedule>
          <RunAs>
            <RunAsDomainAndLogin>string</RunAsDomainAndLogin>
            <RunAsPassword>string</RunAsPassword>
          </RunAs>
          <Options>
            <RunScheduledBackup>boolean</RunScheduledBackup>
            <RunWhenNotLoggedOn>boolean</RunWhenNotLoggedOn>
            <SendEmailReportAfterBackup>boolean</SendEmailReportAfterBackup>
            <EmailAddressToSendReportsTo>string</EmailAddressToSendReportsTo>
            <SendEmailReportAfterBackupToBackupAccount>boolean</SendEmailReportAfterBackupToBackupAccount>
            <ExcludeFilesOlderThanDate>dateTime</ExcludeFilesOlderThanDate>
            <ExcludeFilesLargerThanMb>long</ExcludeFilesLargerThanMb>
            <ExcludeFilesSmallerThanKb>long</ExcludeFilesSmallerThanKb>
            <RemoveFilesAfterDays>int</RemoveFilesAfterDays>
            <RemoveDeletedFilesAfterDays>int</RemoveDeletedFilesAfterDays>
          </Options>
          <ScannerFileFilters>
            <Mode>None or IncludeByWildcard or ExcludeByWildCard</Mode>
            <IncludeFiles>string</IncludeFiles>
            <IncludeFolders>string</IncludeFolders>
            <ExcludeFiles>string</ExcludeFiles>
            <ExcludeFolders>string</ExcludeFolders>
          </ScannerFileFilters>
          <UseSystemAccountForScanningUserPersonalFolders>boolean</UseSystemAccountForScanningUserPersonalFolders>
          <LiveProtectWholeBackupSet>boolean</LiveProtectWholeBackupSet>
        </EntityPolicy>
      </DeleteEntityPolicyResult>
    </DeleteEntityPolicyResponse>
  </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>
    <DeleteEntityPolicy xmlns="sosonlinebackup.com">
      <entityPolicyID>int</entityPolicyID>
      <targetEntityId>int</targetEntityId>
      <unassignAccounts>boolean</unassignAccounts>
    </DeleteEntityPolicy>
  </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>
    <DeleteEntityPolicyResponse xmlns="sosonlinebackup.com">
      <DeleteEntityPolicyResult>
        <Result />
        <EntityPolicy>
          <EntityBackupPolicyID>int</EntityBackupPolicyID>
          <TargetEntityID>int</TargetEntityID>
          <PolicyName>string</PolicyName>
          <DateCreated>dateTime</DateCreated>
          <BackupSet>
            <ScannerMode>ScanAll or ScanPersonal or DontScan</ScannerMode>
            <BackupDocuments>boolean</BackupDocuments>
            <BackupImages>boolean</BackupImages>
            <BackupMusic>boolean</BackupMusic>
            <BackupVideo>boolean</BackupVideo>
            <BackupCustom>boolean</BackupCustom>
            <CustomFileTypes>string</CustomFileTypes>
            <ExcludeFileTypes>string</ExcludeFileTypes>
          </BackupSet>
          <Schedule>
            <ScheduleType>Monthly or Weekly or Daily or Hourly</ScheduleType>
            <ScheduledTime>dateTime</ScheduledTime>
            <ScheduledDayOfTheMonth>unsignedByte</ScheduledDayOfTheMonth>
            <ScheduledDayOfTheWeek>Sunday or Monday or Tuesday or Wednesday or Thursday or Friday or Saturday</ScheduledDayOfTheWeek>
            <ScheduledHoursBetweenRuns>unsignedByte</ScheduledHoursBetweenRuns>
            <ScheduledEndTime>dateTime</ScheduledEndTime>
            <UseEndTime>boolean</UseEndTime>
          </Schedule>
          <RunAs>
            <RunAsDomainAndLogin>string</RunAsDomainAndLogin>
            <RunAsPassword>string</RunAsPassword>
          </RunAs>
          <Options>
            <RunScheduledBackup>boolean</RunScheduledBackup>
            <RunWhenNotLoggedOn>boolean</RunWhenNotLoggedOn>
            <SendEmailReportAfterBackup>boolean</SendEmailReportAfterBackup>
            <EmailAddressToSendReportsTo>string</EmailAddressToSendReportsTo>
            <SendEmailReportAfterBackupToBackupAccount>boolean</SendEmailReportAfterBackupToBackupAccount>
            <ExcludeFilesOlderThanDate>dateTime</ExcludeFilesOlderThanDate>
            <ExcludeFilesLargerThanMb>long</ExcludeFilesLargerThanMb>
            <ExcludeFilesSmallerThanKb>long</ExcludeFilesSmallerThanKb>
            <RemoveFilesAfterDays>int</RemoveFilesAfterDays>
            <RemoveDeletedFilesAfterDays>int</RemoveDeletedFilesAfterDays>
          </Options>
          <ScannerFileFilters>
            <Mode>None or IncludeByWildcard or ExcludeByWildCard</Mode>
            <IncludeFiles>string</IncludeFiles>
            <IncludeFolders>string</IncludeFolders>
            <ExcludeFiles>string</ExcludeFiles>
            <ExcludeFolders>string</ExcludeFolders>
          </ScannerFileFilters>
          <UseSystemAccountForScanningUserPersonalFolders>boolean</UseSystemAccountForScanningUserPersonalFolders>
          <LiveProtectWholeBackupSet>boolean</LiveProtectWholeBackupSet>
        </EntityPolicy>
      </DeleteEntityPolicyResult>
    </DeleteEntityPolicyResponse>
  </soap12:Body>
</soap12:Envelope>