email Web Service

Click here for a complete list of operations.

addEmailToQueue

adds an ctDynamicsSL.email.DSLEmail object to the system queue for emailing out

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 /ctapi/services/ctDynamicsSL/email.asmx HTTP/1.1
Host: www.catalinatechnology.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.catalinaTechnology.com/services/ctDynamicsSL/addEmailToQueue"

<?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>
    <ctDynamicsSLHeader xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap:Header>
  <soap:Body>
    <addEmailToQueue xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <inEmail>
        <siteID>string</siteID>
        <errorMessage>string</errorMessage>
        <emailTemplateName>string</emailTemplateName>
        <emailGUID>string</emailGUID>
        <toUserGUID>string</toUserGUID>
        <toName>string</toName>
        <toAddress>string</toAddress>
        <bcc>string</bcc>
        <fromName>string</fromName>
        <fromAddress>string</fromAddress>
        <subject>string</subject>
        <url>string</url>
        <pdfURL>string</pdfURL>
        <urlQueryString>string</urlQueryString>
        <urlQueryStringEncrypted>boolean</urlQueryStringEncrypted>
        <content>string</content>
        <containsHtml>string</containsHtml>
        <attachments>
          <DSLEmailAttachment>
            <fileName>string</fileName>
            <fileContent>base64Binary</fileContent>
            <getPDF>short</getPDF>
            <pdfURL>string</pdfURL>
          </DSLEmailAttachment>
          <DSLEmailAttachment>
            <fileName>string</fileName>
            <fileContent>base64Binary</fileContent>
            <getPDF>short</getPDF>
            <pdfURL>string</pdfURL>
          </DSLEmailAttachment>
        </attachments>
      </inEmail>
    </addEmailToQueue>
  </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>
    <addEmailToQueueResponse xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <addEmailToQueueResult>
        <xsd:schema>schema</xsd:schema>xml</addEmailToQueueResult>
    </addEmailToQueueResponse>
  </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 /ctapi/services/ctDynamicsSL/email.asmx HTTP/1.1
Host: www.catalinatechnology.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>
    <ctDynamicsSLHeader xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap12:Header>
  <soap12:Body>
    <addEmailToQueue xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <inEmail>
        <siteID>string</siteID>
        <errorMessage>string</errorMessage>
        <emailTemplateName>string</emailTemplateName>
        <emailGUID>string</emailGUID>
        <toUserGUID>string</toUserGUID>
        <toName>string</toName>
        <toAddress>string</toAddress>
        <bcc>string</bcc>
        <fromName>string</fromName>
        <fromAddress>string</fromAddress>
        <subject>string</subject>
        <url>string</url>
        <pdfURL>string</pdfURL>
        <urlQueryString>string</urlQueryString>
        <urlQueryStringEncrypted>boolean</urlQueryStringEncrypted>
        <content>string</content>
        <containsHtml>string</containsHtml>
        <attachments>
          <DSLEmailAttachment>
            <fileName>string</fileName>
            <fileContent>base64Binary</fileContent>
            <getPDF>short</getPDF>
            <pdfURL>string</pdfURL>
          </DSLEmailAttachment>
          <DSLEmailAttachment>
            <fileName>string</fileName>
            <fileContent>base64Binary</fileContent>
            <getPDF>short</getPDF>
            <pdfURL>string</pdfURL>
          </DSLEmailAttachment>
        </attachments>
      </inEmail>
    </addEmailToQueue>
  </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>
    <addEmailToQueueResponse xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <addEmailToQueueResult>
        <xsd:schema>schema</xsd:schema>xml</addEmailToQueueResult>
    </addEmailToQueueResponse>
  </soap12:Body>
</soap12:Envelope>