Query Submissions

URL

https://api.datawitness.net/dw/submissions

Request

curl --digest -u 'USERNAME:PASSWORD' -H 'X-Datawitness-Key: key="APIKEY"' \ https://api.datawitness.net/dw/submissions

Response

    <?xml version="1.0" encoding="UTF-8"?>
    <response status="ok">
      <Submissions>
        <submission type="8" broadcast="1|0">
          <id> </id>
          <form_reference> </form_reference>
          <sender>
            <user_fullname> </user_fullname>
            <user_email> </user_email>
          </sender>
          <primary_recipient>
            <name> </name>
            <email> </email>
            <!-- If TrueAuth is used, then that information is also shown here -->
            <trueauth> </trueauth>
            <trueauth_number> </trueauth_number>
          </primary_recipient>
          <silent>0|1</silent>
          <completed>0|1</completed>
          <md5_id> </md5_id>
          <created> </created>
        </submission>
        ...
      </Submissions>
    </response>
  

Submission Details

URL

https://api.datawitness.net/dw/submissions/submission_id

Request

curl --digest -u 'USERNAME:PASSWORD' -H 'X-Datawitness-Key: key="APIKEY"' \ https://api.datawitness.net/dw/submissions/submission_id

Response

  <?xml version="1.0" encoding="UTF-8"?>
  <response status="ok">
    <submission type="8" broadcast="1|0">
      <id> </id>
      <form_reference> </form_reference>
      <sender>
        <user_fullname> </user_fullname>
        <user_email> </user_email>
      </sender>
      <recipients>
        <recipient>
          <name> </name>
          <email> </email>
          <recp_type>PRIMARY|REGULAR|COPIED</recp_type>
          <submission_viewed>0|1</submission_viewed>
          <time_viewed> </time_viewed>
          <response_status>0|1</response_status>
          <response_viewed>0|1</response_viewed>
          <responded> </responded>
          <comment><![CDATA[ ]]></comment>
          <endorsement><![CDATA[ ]]></endorsement>
          <created> </created>
          <notification_viewed>0|1</notification_viewed>
        </recipient>
        ...
      </recipients>
      <attachments>
        <attachment>
          <id> </id>
          <ticket> </ticket>
          <name> </name>
        </attachment>
        ...
      </attachments>
      <total>
        <involved> </involved>
        <signing> </signing>
        <nonsigning> </nonsigning>
        <accepted> </accepted>
        <clarified> </clarified>
        <rejected> </rejected>
      </total>
      <completed>0|1</completed>
      <silent>0|1</silent>
      <md5_id> </md5_id>
      <created></created>
    </submission>
  </response>
  

Submission History

URL

https://api.datawitness.net/dw/submissions/submission_id/history

Request

curl --digest -u 'USERNAME:PASSWORD' -H 'X-Datawitness-Key: key="APIKEY"' \ https://api.datawitness.net/dw/submissions/submission_id/history

Response

  <?xml version="1.0" encoding="UTF-8"?>
  <response status="ok">
    <history>
      <submission_id> </submission_id>
      <created> </created>
      <events>
        <historyEvent>
          <time> </time>
          <description><![CDATA[ ]]></description>
        </historyEvent>
	...
      </events>
      <summary>
        <time> </time>
        <total>
          <involved> </involved>
          <signing> </signing>
          <nonsigning> </nonsigning>
          <accepted> </accepted>
        </total>
      </summary>
    </history>
  </response>
  

Create A Submission

URL

https://api.datawitness.net/dw/submissions

Request

curl --digest -u 'USERNAME:PASSWORD' -H 'X-Datawitness-Key: key="APIKEY"' \ -F "attachment[]=@sample.pdf;type=application/pdf;" \ -F "attachment[]=@sample.gif;type=image/gif;" \ -F "attachment[]=@contract.xml;type=application/xml;" \ -X POST https://api.datawitness.net/dw/submissions

XML Package (contract.xml)

<?xml version="1.0" encoding="UTF-8"?> <submission type="" broadcast=""> <form_reference> </form_reference> <transparency></transparency> <confirm_intent></confirm_intent> <recipients> <recipient type=""> <first_name></first_name> <last_name></last_name> <email_address> </email_address> <!-- If TrueAuth is being called, then that information is --> <!-- included here as it relates to the recipient being authenticated --> <trueauth> </trueauth> <trueauth_number> </trueauth_number> </recipient> ... </recipients> <cover_note><![CDATA[ ]]></cover_note> <data><![CDATA[ ]]></data> <attachments> <attachment name="FILENAME.EXT"/> </attachments> </submission>

Response

  <?xml version="1.0" encoding="UTF-8"?>
  <response status="ok">
      <submission status="created">
        <id>14031</id>
      </submission>
    </response>
  

Status

URL

https://api.datawitness.net/dw/submissions/submission_id/status

Request

curl --digest -u 'USERNAME:PASSWORD' -H 'X-Datawitness-Key: key="APIKEY"' \ https://api.datawitness.net/dw/submissions/submission_id/status

Response

    <?xml version="1.0" encoding="UTF-8"?>
    <response status="ok">
      <submission type=" " broadcast=" ">
        <id> </id>
        <form_reference> </form_reference>
        <status>PENDING|COMPLETED</status>
      </submission>
    </response>
 

Submission Attachments

URL

https://api.datawitness.net/dw/submissions/submission_id/attachment/file_id/ticket

Request

curl --digest -u 'USERNAME:PASSWORD' -H 'X-Datawitness-Key: key="APIKEY"' \ https://api.datawitness.net/dw/submissions/submission_id/attachment/file_id/ticket

Response

    Raw Data with accompanying headers
  

Submission Summary

URL

https://api.datawitness.net/dw/submissions/submission_id/summary

Request

curl --digest -u 'USERNAME:PASSWORD' -H 'X-Datawitness-Key: key="APIKEY"' \ https://api.datawitness.net/dw/submissions/submission_id/summary

Response

    PDF File