LitmusSoapApi Web Service

LitmusSoapApi

Click here for a complete list of operations.

GetEmailTestClients

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 /2010-06-21/api.asmx HTTP/1.1
Host: soapapi.litmusapp.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "GetEmailTestClients"

<?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:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="https://soapapi.litmusapp.com/" xmlns:types="https://soapapi.litmusapp.com/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:GetEmailTestClients>
      <apiKey xsi:type="xsd:string">string</apiKey>
      <apiPass xsi:type="xsd:string">string</apiPass>
    </tns:GetEmailTestClients>
  </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:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="https://soapapi.litmusapp.com/" xmlns:types="https://soapapi.litmusapp.com/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:GetEmailTestClientsResponse>
      <GetEmailTestClientsResult href="#id1" />
    </tns:GetEmailTestClientsResponse>
    <soapenc:Array id="id1" soapenc:arrayType="types:Client[2]">
      <Item href="#id2" />
      <Item href="#id3" />
    </soapenc:Array>
    <types:Client id="id2" xsi:type="types:Client">
      <State xsi:type="xsd:string">string</State>
      <WindowImageContentBlocking xsi:type="xsd:string">string</WindowImageContentBlocking>
      <FullpageImageThumb xsi:type="xsd:string">string</FullpageImageThumb>
      <BusinessOrPopular xsi:type="xsd:boolean">boolean</BusinessOrPopular>
      <WindowImageThumbNoContentBlocking xsi:type="xsd:string">string</WindowImageThumbNoContentBlocking>
      <Completed xsi:type="xsd:boolean">boolean</Completed>
      <FullpageImage xsi:type="xsd:string">string</FullpageImage>
      <FoundInSpam xsi:type="xsd:boolean">boolean</FoundInSpam>
      <Status xsi:type="xsd:int">int</Status>
      <WindowImageNoContentBlocking xsi:type="xsd:string">string</WindowImageNoContentBlocking>
      <PlatformName xsi:type="xsd:string">string</PlatformName>
      <AverageTimeToProcess xsi:type="xsd:int">int</AverageTimeToProcess>
      <SpamHeaders href="#id4" />
      <WindowImageThumb xsi:type="xsd:string">string</WindowImageThumb>
      <RenderedHtmlUrl xsi:type="xsd:string">string</RenderedHtmlUrl>
      <PlatformLongName xsi:type="xsd:string">string</PlatformLongName>
      <FullpageImageThumbContentBlocking xsi:type="xsd:string">string</FullpageImageThumbContentBlocking>
      <WindowImage xsi:type="xsd:string">string</WindowImage>
      <FullpageImageContentBlocking xsi:type="xsd:string">string</FullpageImageContentBlocking>
      <SupportsContentBlocking xsi:type="xsd:boolean">boolean</SupportsContentBlocking>
      <ApplicationName xsi:type="xsd:string">string</ApplicationName>
      <FullpageImageThumbNoContentBlocking xsi:type="xsd:string">string</FullpageImageThumbNoContentBlocking>
      <SpamScore xsi:type="xsd:double">double</SpamScore>
      <DesktopClient xsi:type="xsd:boolean">boolean</DesktopClient>
      <WindowImageThumbContentBlocking xsi:type="xsd:string">string</WindowImageThumbContentBlocking>
      <Id xsi:type="xsd:long">long</Id>
      <ResultType xsi:type="xsd:string">string</ResultType>
      <FullpageImageNoContentBlocking xsi:type="xsd:string">string</FullpageImageNoContentBlocking>
      <ApplicationLongName xsi:type="xsd:string">string</ApplicationLongName>
    </types:Client>
    <types:Client id="id3" xsi:type="types:Client">
      <State xsi:type="xsd:string">string</State>
      <WindowImageContentBlocking xsi:type="xsd:string">string</WindowImageContentBlocking>
      <FullpageImageThumb xsi:type="xsd:string">string</FullpageImageThumb>
      <BusinessOrPopular xsi:type="xsd:boolean">boolean</BusinessOrPopular>
      <WindowImageThumbNoContentBlocking xsi:type="xsd:string">string</WindowImageThumbNoContentBlocking>
      <Completed xsi:type="xsd:boolean">boolean</Completed>
      <FullpageImage xsi:type="xsd:string">string</FullpageImage>
      <FoundInSpam xsi:type="xsd:boolean">boolean</FoundInSpam>
      <Status xsi:type="xsd:int">int</Status>
      <WindowImageNoContentBlocking xsi:type="xsd:string">string</WindowImageNoContentBlocking>
      <PlatformName xsi:type="xsd:string">string</PlatformName>
      <AverageTimeToProcess xsi:type="xsd:int">int</AverageTimeToProcess>
      <SpamHeaders href="#id5" />
      <WindowImageThumb xsi:type="xsd:string">string</WindowImageThumb>
      <RenderedHtmlUrl xsi:type="xsd:string">string</RenderedHtmlUrl>
      <PlatformLongName xsi:type="xsd:string">string</PlatformLongName>
      <FullpageImageThumbContentBlocking xsi:type="xsd:string">string</FullpageImageThumbContentBlocking>
      <WindowImage xsi:type="xsd:string">string</WindowImage>
      <FullpageImageContentBlocking xsi:type="xsd:string">string</FullpageImageContentBlocking>
      <SupportsContentBlocking xsi:type="xsd:boolean">boolean</SupportsContentBlocking>
      <ApplicationName xsi:type="xsd:string">string</ApplicationName>
      <FullpageImageThumbNoContentBlocking xsi:type="xsd:string">string</FullpageImageThumbNoContentBlocking>
      <SpamScore xsi:type="xsd:double">double</SpamScore>
      <DesktopClient xsi:type="xsd:boolean">boolean</DesktopClient>
      <WindowImageThumbContentBlocking xsi:type="xsd:string">string</WindowImageThumbContentBlocking>
      <Id xsi:type="xsd:long">long</Id>
      <ResultType xsi:type="xsd:string">string</ResultType>
      <FullpageImageNoContentBlocking xsi:type="xsd:string">string</FullpageImageNoContentBlocking>
      <ApplicationLongName xsi:type="xsd:string">string</ApplicationLongName>
    </types:Client>
    <soapenc:Array id="id4" soapenc:arrayType="types:SpamHeader[2]">
      <Item href="#id6" />
      <Item href="#id7" />
    </soapenc:Array>
    <soapenc:Array id="id5" soapenc:arrayType="types:SpamHeader[2]">
      <Item href="#id8" />
      <Item href="#id9" />
    </soapenc:Array>
    <types:SpamHeader id="id6" xsi:type="types:SpamHeader">
      <Key xsi:type="xsd:string">string</Key>
      <ID xsi:type="xsd:int">int</ID>
      <Description xsi:type="xsd:string">string</Description>
      <Rating xsi:type="xsd:int">int</Rating>
    </types:SpamHeader>
    <types:SpamHeader id="id7" xsi:type="types:SpamHeader">
      <Key xsi:type="xsd:string">string</Key>
      <ID xsi:type="xsd:int">int</ID>
      <Description xsi:type="xsd:string">string</Description>
      <Rating xsi:type="xsd:int">int</Rating>
    </types:SpamHeader>
    <types:SpamHeader id="id8" xsi:type="types:SpamHeader">
      <Key xsi:type="xsd:string">string</Key>
      <ID xsi:type="xsd:int">int</ID>
      <Description xsi:type="xsd:string">string</Description>
      <Rating xsi:type="xsd:int">int</Rating>
    </types:SpamHeader>
    <types:SpamHeader id="id9" xsi:type="types:SpamHeader">
      <Key xsi:type="xsd:string">string</Key>
      <ID xsi:type="xsd:int">int</ID>
      <Description xsi:type="xsd:string">string</Description>
      <Rating xsi:type="xsd:int">int</Rating>
    </types:SpamHeader>
  </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 /2010-06-21/api.asmx HTTP/1.1
Host: soapapi.litmusapp.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:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="https://soapapi.litmusapp.com/" xmlns:types="https://soapapi.litmusapp.com/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:GetEmailTestClients>
      <apiKey xsi:type="xsd:string">string</apiKey>
      <apiPass xsi:type="xsd:string">string</apiPass>
    </tns:GetEmailTestClients>
  </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:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="https://soapapi.litmusapp.com/" xmlns:types="https://soapapi.litmusapp.com/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:GetEmailTestClientsResponse>
      <rpc:result xmlns="">GetEmailTestClientsResult</rpc:result>
      <GetEmailTestClientsResult soapenc:id="id0" soapenc:itemType="types:Client" soapenc:arraySize="2">
        <Item soapenc:id="id1">
          <State xsi:type="xsd:string">string</State>
          <WindowImageContentBlocking xsi:type="xsd:string">string</WindowImageContentBlocking>
          <FullpageImageThumb xsi:type="xsd:string">string</FullpageImageThumb>
          <BusinessOrPopular xsi:type="xsd:boolean">boolean</BusinessOrPopular>
          <WindowImageThumbNoContentBlocking xsi:type="xsd:string">string</WindowImageThumbNoContentBlocking>
          <Completed xsi:type="xsd:boolean">boolean</Completed>
          <FullpageImage xsi:type="xsd:string">string</FullpageImage>
          <FoundInSpam xsi:type="xsd:boolean">boolean</FoundInSpam>
          <Status xsi:type="xsd:int">int</Status>
          <WindowImageNoContentBlocking xsi:type="xsd:string">string</WindowImageNoContentBlocking>
          <PlatformName xsi:type="xsd:string">string</PlatformName>
          <AverageTimeToProcess xsi:type="xsd:int">int</AverageTimeToProcess>
          <SpamHeaders soapenc:id="id2" soapenc:itemType="types:SpamHeader" soapenc:arraySize="2">
            <Item soapenc:id="id3">
              <Key xsi:type="xsd:string">string</Key>
              <ID xsi:type="xsd:int">int</ID>
              <Description xsi:type="xsd:string">string</Description>
              <Rating xsi:type="xsd:int">int</Rating>
            </Item>
            <Item soapenc:id="id4">
              <Key xsi:type="xsd:string">string</Key>
              <ID xsi:type="xsd:int">int</ID>
              <Description xsi:type="xsd:string">string</Description>
              <Rating xsi:type="xsd:int">int</Rating>
            </Item>
          </SpamHeaders>
          <WindowImageThumb xsi:type="xsd:string">string</WindowImageThumb>
          <RenderedHtmlUrl xsi:type="xsd:string">string</RenderedHtmlUrl>
          <PlatformLongName xsi:type="xsd:string">string</PlatformLongName>
          <FullpageImageThumbContentBlocking xsi:type="xsd:string">string</FullpageImageThumbContentBlocking>
          <WindowImage xsi:type="xsd:string">string</WindowImage>
          <FullpageImageContentBlocking xsi:type="xsd:string">string</FullpageImageContentBlocking>
          <SupportsContentBlocking xsi:type="xsd:boolean">boolean</SupportsContentBlocking>
          <ApplicationName xsi:type="xsd:string">string</ApplicationName>
          <FullpageImageThumbNoContentBlocking xsi:type="xsd:string">string</FullpageImageThumbNoContentBlocking>
          <SpamScore xsi:type="xsd:double">double</SpamScore>
          <DesktopClient xsi:type="xsd:boolean">boolean</DesktopClient>
          <WindowImageThumbContentBlocking xsi:type="xsd:string">string</WindowImageThumbContentBlocking>
          <Id xsi:type="xsd:long">long</Id>
          <ResultType xsi:type="xsd:string">string</ResultType>
          <FullpageImageNoContentBlocking xsi:type="xsd:string">string</FullpageImageNoContentBlocking>
          <ApplicationLongName xsi:type="xsd:string">string</ApplicationLongName>
        </Item>
        <Item soapenc:id="id5">
          <State xsi:type="xsd:string">string</State>
          <WindowImageContentBlocking xsi:type="xsd:string">string</WindowImageContentBlocking>
          <FullpageImageThumb xsi:type="xsd:string">string</FullpageImageThumb>
          <BusinessOrPopular xsi:type="xsd:boolean">boolean</BusinessOrPopular>
          <WindowImageThumbNoContentBlocking xsi:type="xsd:string">string</WindowImageThumbNoContentBlocking>
          <Completed xsi:type="xsd:boolean">boolean</Completed>
          <FullpageImage xsi:type="xsd:string">string</FullpageImage>
          <FoundInSpam xsi:type="xsd:boolean">boolean</FoundInSpam>
          <Status xsi:type="xsd:int">int</Status>
          <WindowImageNoContentBlocking xsi:type="xsd:string">string</WindowImageNoContentBlocking>
          <PlatformName xsi:type="xsd:string">string</PlatformName>
          <AverageTimeToProcess xsi:type="xsd:int">int</AverageTimeToProcess>
          <SpamHeaders soapenc:id="id6" soapenc:itemType="types:SpamHeader" soapenc:arraySize="2">
            <Item soapenc:id="id7">
              <Key xsi:type="xsd:string">string</Key>
              <ID xsi:type="xsd:int">int</ID>
              <Description xsi:type="xsd:string">string</Description>
              <Rating xsi:type="xsd:int">int</Rating>
            </Item>
            <Item soapenc:id="id8">
              <Key xsi:type="xsd:string">string</Key>
              <ID xsi:type="xsd:int">int</ID>
              <Description xsi:type="xsd:string">string</Description>
              <Rating xsi:type="xsd:int">int</Rating>
            </Item>
          </SpamHeaders>
          <WindowImageThumb xsi:type="xsd:string">string</WindowImageThumb>
          <RenderedHtmlUrl xsi:type="xsd:string">string</RenderedHtmlUrl>
          <PlatformLongName xsi:type="xsd:string">string</PlatformLongName>
          <FullpageImageThumbContentBlocking xsi:type="xsd:string">string</FullpageImageThumbContentBlocking>
          <WindowImage xsi:type="xsd:string">string</WindowImage>
          <FullpageImageContentBlocking xsi:type="xsd:string">string</FullpageImageContentBlocking>
          <SupportsContentBlocking xsi:type="xsd:boolean">boolean</SupportsContentBlocking>
          <ApplicationName xsi:type="xsd:string">string</ApplicationName>
          <FullpageImageThumbNoContentBlocking xsi:type="xsd:string">string</FullpageImageThumbNoContentBlocking>
          <SpamScore xsi:type="xsd:double">double</SpamScore>
          <DesktopClient xsi:type="xsd:boolean">boolean</DesktopClient>
          <WindowImageThumbContentBlocking xsi:type="xsd:string">string</WindowImageThumbContentBlocking>
          <Id xsi:type="xsd:long">long</Id>
          <ResultType xsi:type="xsd:string">string</ResultType>
          <FullpageImageNoContentBlocking xsi:type="xsd:string">string</FullpageImageNoContentBlocking>
          <ApplicationLongName xsi:type="xsd:string">string</ApplicationLongName>
        </Item>
      </GetEmailTestClientsResult>
    </tns:GetEmailTestClientsResponse>
  </soap12:Body>
</soap12:Envelope>