ConfigService


Click here for a complete list of operations.

WriteWebUrlFilteringPolicy

Please see latest endpoint documentation for more details

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 /customerapi-1-22/configservice/service.asmx HTTP/1.1
Host: api.messagelabs.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.messagelabs.com/2005/01/Customer/WriteWebUrlFilteringPolicy"

<?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>
    <WriteWebUrlFilteringPolicyRequest xmlns="http://api.messagelabs.com/2005/01/Customer">
      <Policy>
        <OptimisticLockValue>base64Binary</OptimisticLockValue>
        <Id>int</Id>
        <Name>string</Name>
        <Order>int</Order>
        <Active>boolean</Active>
        <Action>None or Allow or AllowAndLog or Block or BlockAndLog</Action>
        <TimePeriod>
          <Id>int</Id>
          <PolicyId>int</PolicyId>
          <Timezone>string</Timezone>
          <Details>
            <PolicyTimePeriodDetail xsi:nil="true" />
            <PolicyTimePeriodDetail xsi:nil="true" />
          </Details>
        </TimePeriod>
        <Urls>
          <PolicyUrl>
            <Id>int</Id>
            <Url>string</Url>
          </PolicyUrl>
          <PolicyUrl>
            <Id>int</Id>
            <Url>string</Url>
          </PolicyUrl>
        </Urls>
        <Categories>
          <PolicyCategory>
            <Id>int</Id>
            <Name>string</Name>
          </PolicyCategory>
          <PolicyCategory>
            <Id>int</Id>
            <Name>string</Name>
          </PolicyCategory>
        </Categories>
        <SelectedFileTypes>
          <PolicyFileType>
            <Id>int</Id>
            <Name>string</Name>
            <Extension>string</Extension>
            <IsDefault>boolean</IsDefault>
          </PolicyFileType>
          <PolicyFileType>
            <Id>int</Id>
            <Name>string</Name>
            <Extension>string</Extension>
            <IsDefault>boolean</IsDefault>
          </PolicyFileType>
        </SelectedFileTypes>
        <SelectedMimeTypes>
          <PolicyMimeType>
            <Id>int</Id>
            <Name>string</Name>
            <CategoryName>string</CategoryName>
            <IsDefault>boolean</IsDefault>
          </PolicyMimeType>
          <PolicyMimeType>
            <Id>int</Id>
            <Name>string</Name>
            <CategoryName>string</CategoryName>
            <IsDefault>boolean</IsDefault>
          </PolicyMimeType>
        </SelectedMimeTypes>
        <CustomGroups>
          <PolicyCustomGroup>
            <Id>int</Id>
            <CustomerId>int</CustomerId>
            <Name>string</Name>
            <Users xsi:nil="true" />
            <ExternalIPRanges xsi:nil="true" />
            <PolicyCount>int</PolicyCount>
            <OptimisticLockValue>base64Binary</OptimisticLockValue>
            <GroupCount>int</GroupCount>
          </PolicyCustomGroup>
          <PolicyCustomGroup>
            <Id>int</Id>
            <CustomerId>int</CustomerId>
            <Name>string</Name>
            <Users xsi:nil="true" />
            <ExternalIPRanges xsi:nil="true" />
            <PolicyCount>int</PolicyCount>
            <OptimisticLockValue>base64Binary</OptimisticLockValue>
            <GroupCount>int</GroupCount>
          </PolicyCustomGroup>
        </CustomGroups>
        <DirectoryGroups>
          <PolicyDirectoryGroup>
            <Id>int</Id>
            <CustomerId>int</CustomerId>
            <ActiveDirectoryId>string</ActiveDirectoryId>
            <Name>string</Name>
            <UserList xsi:nil="true" />
            <UserCount>int</UserCount>
            <TotalGroupCountForCustomer>int</TotalGroupCountForCustomer>
            <HasDirectAssociation>boolean</HasDirectAssociation>
          </PolicyDirectoryGroup>
          <PolicyDirectoryGroup>
            <Id>int</Id>
            <CustomerId>int</CustomerId>
            <ActiveDirectoryId>string</ActiveDirectoryId>
            <Name>string</Name>
            <UserList xsi:nil="true" />
            <UserCount>int</UserCount>
            <TotalGroupCountForCustomer>int</TotalGroupCountForCustomer>
            <HasDirectAssociation>boolean</HasDirectAssociation>
          </PolicyDirectoryGroup>
        </DirectoryGroups>
        <AdminEmailAddress>string</AdminEmailAddress>
        <NotifyAdmin>boolean</NotifyAdmin>
        <NotifyUsers>boolean</NotifyUsers>
        <UseTimePeriods>boolean</UseTimePeriods>
        <UseGroups>boolean</UseGroups>
        <UseUrlCategories>boolean</UseUrlCategories>
        <UseSpecificUrls>boolean</UseSpecificUrls>
        <UseContentTypes>boolean</UseContentTypes>
        <CustomerId>int</CustomerId>
      </Policy>
      <Delete>boolean</Delete>
    </WriteWebUrlFilteringPolicyRequest>
  </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>
    <From.WriteWebUrlFilteringPolicyResponse xmlns="http://api.messagelabs.com/2005/01/Customer">
      <Id>int</Id>
      <OptimisticLockValue>base64Binary</OptimisticLockValue>
    </From.WriteWebUrlFilteringPolicyResponse>
  </soap:Body>
</soap:Envelope>