BulksignApi


Click here for a complete list of operations.

GetEnvelopeDetails

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 /webapi/bulksignapi.asmx HTTP/1.1
Host: bulksign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://bulksign.com/GetEnvelopeDetails"

<?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>
    <GetEnvelopeDetails xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <envelopeId>string</envelopeId>
    </GetEnvelopeDetails>
  </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>
    <GetEnvelopeDetailsResponse xmlns="http://bulksign.com/">
      <GetEnvelopeDetailsResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>
          <EnvelopeId>string</EnvelopeId>
          <Name>string</Name>
          <EnvelopeType>Serial or Concurrent or Bulk</EnvelopeType>
          <ReminderOptions>
            <EnableReminders>boolean</EnableReminders>
            <RecurrentEachDays>int</RecurrentEachDays>
          </ReminderOptions>
          <Recipients>
            <RecipientResultApiModel xsi:nil="true" />
            <RecipientResultApiModel xsi:nil="true" />
          </Recipients>
          <Documents>
            <DocumentResultApiModel xsi:nil="true" />
            <DocumentResultApiModel xsi:nil="true" />
          </Documents>
          <Status>InProgress or Completed or Canceled or Expired or Deleted</Status>
          <SentDateUTC>dateTime</SentDateUTC>
          <ExpirationDateUTC>dateTime</ExpirationDateUTC>
          <LastModifiedDateUTC>dateTime</LastModifiedDateUTC>
          <Language>string</Language>
          <Metadata>string</Metadata>
          <BackupToken>string</BackupToken>
          <CertifyDocumentsBeforeSending>boolean</CertifyDocumentsBeforeSending>
          <PreventFormFieldEditOnEnvelopeCompletion>boolean</PreventFormFieldEditOnEnvelopeCompletion>
          <EnableBatchSign>boolean</EnableBatchSign>
          <AllowRecipientDelegation>boolean</AllowRecipientDelegation>
          <DisableSignerEmailNotifications>boolean</DisableSignerEmailNotifications>
          <DisableSignersShouldReceiveCompletedDocuments>boolean</DisableSignersShouldReceiveCompletedDocuments>
          <DocumentTimestampType>None or Recipient or Envelope</DocumentTimestampType>
        </Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </GetEnvelopeDetailsResult>
    </GetEnvelopeDetailsResponse>
  </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 /webapi/bulksignapi.asmx HTTP/1.1
Host: bulksign.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>
    <GetEnvelopeDetails xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <envelopeId>string</envelopeId>
    </GetEnvelopeDetails>
  </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>
    <GetEnvelopeDetailsResponse xmlns="http://bulksign.com/">
      <GetEnvelopeDetailsResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>
          <EnvelopeId>string</EnvelopeId>
          <Name>string</Name>
          <EnvelopeType>Serial or Concurrent or Bulk</EnvelopeType>
          <ReminderOptions>
            <EnableReminders>boolean</EnableReminders>
            <RecurrentEachDays>int</RecurrentEachDays>
          </ReminderOptions>
          <Recipients>
            <RecipientResultApiModel xsi:nil="true" />
            <RecipientResultApiModel xsi:nil="true" />
          </Recipients>
          <Documents>
            <DocumentResultApiModel xsi:nil="true" />
            <DocumentResultApiModel xsi:nil="true" />
          </Documents>
          <Status>InProgress or Completed or Canceled or Expired or Deleted</Status>
          <SentDateUTC>dateTime</SentDateUTC>
          <ExpirationDateUTC>dateTime</ExpirationDateUTC>
          <LastModifiedDateUTC>dateTime</LastModifiedDateUTC>
          <Language>string</Language>
          <Metadata>string</Metadata>
          <BackupToken>string</BackupToken>
          <CertifyDocumentsBeforeSending>boolean</CertifyDocumentsBeforeSending>
          <PreventFormFieldEditOnEnvelopeCompletion>boolean</PreventFormFieldEditOnEnvelopeCompletion>
          <EnableBatchSign>boolean</EnableBatchSign>
          <AllowRecipientDelegation>boolean</AllowRecipientDelegation>
          <DisableSignerEmailNotifications>boolean</DisableSignerEmailNotifications>
          <DisableSignersShouldReceiveCompletedDocuments>boolean</DisableSignersShouldReceiveCompletedDocuments>
          <DocumentTimestampType>None or Recipient or Envelope</DocumentTimestampType>
        </Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </GetEnvelopeDetailsResult>
    </GetEnvelopeDetailsResponse>
  </soap12:Body>
</soap12:Envelope>