ConfigService Web Service

ConfigService

Click here for a complete list of operations.

ReadRegisteredUserSummary

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/ReadRegisteredUserSummary"

<?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>
    <ReadRegisteredUserSummaryRequest xmlns="http://api.messagelabs.com/2005/01/Customer">
      <CustomerId>int</CustomerId>
    </ReadRegisteredUserSummaryRequest>
  </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>
    <ReadRegisteredUserSummaryResponse xmlns="http://api.messagelabs.com/2005/01/Customer">
      <DomainCount>int</DomainCount>
      <RegisteredUserSummary>
        <RegisteredUserSummary>
          <DomainId>int</DomainId>
          <Domain>string</Domain>
          <HasRegisteredUserService>boolean</HasRegisteredUserService>
          <IsClientManaged>boolean</IsClientManaged>
          <UnregisteredUsersSmtpAction>Unknown or Accept or Reject</UnregisteredUsersSmtpAction>
          <RegisteredEmailAddresses>int</RegisteredEmailAddresses>
          <CanRead>boolean</CanRead>
          <CanWrite>boolean</CanWrite>
        </RegisteredUserSummary>
        <RegisteredUserSummary>
          <DomainId>int</DomainId>
          <Domain>string</Domain>
          <HasRegisteredUserService>boolean</HasRegisteredUserService>
          <IsClientManaged>boolean</IsClientManaged>
          <UnregisteredUsersSmtpAction>Unknown or Accept or Reject</UnregisteredUsersSmtpAction>
          <RegisteredEmailAddresses>int</RegisteredEmailAddresses>
          <CanRead>boolean</CanRead>
          <CanWrite>boolean</CanWrite>
        </RegisteredUserSummary>
      </RegisteredUserSummary>
    </ReadRegisteredUserSummaryResponse>
  </soap:Body>
</soap:Envelope>