API Web Service

API

Click here for a complete list of operations.

UploadDocument

Upload a document to the specified folder.

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 /api.asmx HTTP/1.1
Host: r2-api.dotdigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/UploadDocument"

<?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>
    <UploadDocument xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <parentFolderId>int</parentFolderId>
      <filename>string</filename>
      <bytes>base64Binary</bytes>
    </UploadDocument>
  </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>
    <UploadDocumentResponse xmlns="http://apiconnector.com">
      <UploadDocumentResult>
        <Id>int</Id>
        <Name>string</Name>
        <FileName>string</FileName>
        <FileSize>int</FileSize>
        <DateCreated>dateTime</DateCreated>
        <DateModified>dateTime</DateModified>
      </UploadDocumentResult>
    </UploadDocumentResponse>
  </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 /api.asmx HTTP/1.1
Host: r2-api.dotdigital.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>
    <UploadDocument xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <parentFolderId>int</parentFolderId>
      <filename>string</filename>
      <bytes>base64Binary</bytes>
    </UploadDocument>
  </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>
    <UploadDocumentResponse xmlns="http://apiconnector.com">
      <UploadDocumentResult>
        <Id>int</Id>
        <Name>string</Name>
        <FileName>string</FileName>
        <FileSize>int</FileSize>
        <DateCreated>dateTime</DateCreated>
        <DateModified>dateTime</DateModified>
      </UploadDocumentResult>
    </UploadDocumentResponse>
  </soap12:Body>
</soap12:Envelope>