ULTICAB_WS Web Service

ULTICAB_WS

Click here for a complete list of operations.

EmailDocuments

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 /devel/ulticab_ws.asmx HTTP/1.1
Host: www.ulticabinet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.ulticabinet.com/EmailDocuments"

<?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>
    <EmailDocuments xmlns="http://www.ulticabinet.com/">
      <session_id>string</session_id>
      <from_name>string</from_name>
      <from_email>string</from_email>
      <to>string</to>
      <cc>string</cc>
      <bcc>string</bcc>
      <subject>string</subject>
      <body>string</body>
      <document_ids_list>
        <int>int</int>
        <int>int</int>
      </document_ids_list>
      <urgent>boolean</urgent>
      <read_receipt>boolean</read_receipt>
      <consolidate_pdf>boolean</consolidate_pdf>
      <zip_file>boolean</zip_file>
      <additional_attachments_base64>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
      </additional_attachments_base64>
    </EmailDocuments>
  </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>
    <EmailDocumentsResponse xmlns="http://www.ulticabinet.com/">
      <EmailDocumentsResult>boolean</EmailDocumentsResult>
      <email_id>int</email_id>
    </EmailDocumentsResponse>
  </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 /devel/ulticab_ws.asmx HTTP/1.1
Host: www.ulticabinet.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:Body>
    <EmailDocuments xmlns="http://www.ulticabinet.com/">
      <session_id>string</session_id>
      <from_name>string</from_name>
      <from_email>string</from_email>
      <to>string</to>
      <cc>string</cc>
      <bcc>string</bcc>
      <subject>string</subject>
      <body>string</body>
      <document_ids_list>
        <int>int</int>
        <int>int</int>
      </document_ids_list>
      <urgent>boolean</urgent>
      <read_receipt>boolean</read_receipt>
      <consolidate_pdf>boolean</consolidate_pdf>
      <zip_file>boolean</zip_file>
      <additional_attachments_base64>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
      </additional_attachments_base64>
    </EmailDocuments>
  </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>
    <EmailDocumentsResponse xmlns="http://www.ulticabinet.com/">
      <EmailDocumentsResult>boolean</EmailDocumentsResult>
      <email_id>int</email_id>
    </EmailDocumentsResponse>
  </soap12:Body>
</soap12:Envelope>