BulksignApi Web Service

BulksignApi

Click here for a complete list of operations.

AddDocumentsRecipientsToTemplate

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/AddDocumentsRecipientsToTemplate"

<?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>
    <AddDocumentsRecipientsToTemplate xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <model>
        <TemplateId>string</TemplateId>
        <Documents>
          <DocumentApiModel>
            <FileIdentifier xsi:nil="true" />
            <FileContentByteArray xsi:nil="true" />
            <FileContentBase64String xsi:nil="true" />
            <FileNetworkShare xsi:nil="true" />
            <FileName>string</FileName>
            <Index>int</Index>
            <FieldAssignments xsi:nil="true" />
            <NewSignatures xsi:nil="true" />
            <NewAnnotations xsi:nil="true" />
            <NewAttachments xsi:nil="true" />
            <NewTextBoxes xsi:nil="true" />
            <NewComboBoxes xsi:nil="true" />
            <NewCheckBoxes xsi:nil="true" />
            <OverwriteValues xsi:nil="true" />
          </DocumentApiModel>
          <DocumentApiModel>
            <FileIdentifier xsi:nil="true" />
            <FileContentByteArray xsi:nil="true" />
            <FileContentBase64String xsi:nil="true" />
            <FileNetworkShare xsi:nil="true" />
            <FileName>string</FileName>
            <Index>int</Index>
            <FieldAssignments xsi:nil="true" />
            <NewSignatures xsi:nil="true" />
            <NewAnnotations xsi:nil="true" />
            <NewAttachments xsi:nil="true" />
            <NewTextBoxes xsi:nil="true" />
            <NewComboBoxes xsi:nil="true" />
            <NewCheckBoxes xsi:nil="true" />
            <OverwriteValues xsi:nil="true" />
          </DocumentApiModel>
        </Documents>
        <Recipients>
          <RecipientApiModel>
            <Email>string</Email>
            <Name>string</Name>
            <Index>int</Index>
            <PersonalMessage>string</PersonalMessage>
            <RecipientAuthenticationMethods xsi:nil="true" />
            <RecipientType>Signer or ReceivesCopy or AutomaticSigner or Approver</RecipientType>
            <AutomaticSignerProfileIdentifier>string</AutomaticSignerProfileIdentifier>
          </RecipientApiModel>
          <RecipientApiModel>
            <Email>string</Email>
            <Name>string</Name>
            <Index>int</Index>
            <PersonalMessage>string</PersonalMessage>
            <RecipientAuthenticationMethods xsi:nil="true" />
            <RecipientType>Signer or ReceivesCopy or AutomaticSigner or Approver</RecipientType>
            <AutomaticSignerProfileIdentifier>string</AutomaticSignerProfileIdentifier>
          </RecipientApiModel>
        </Recipients>
      </model>
    </AddDocumentsRecipientsToTemplate>
  </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>
    <AddDocumentsRecipientsToTemplateResponse xmlns="http://bulksign.com/">
      <AddDocumentsRecipientsToTemplateResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>string</Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </AddDocumentsRecipientsToTemplateResult>
    </AddDocumentsRecipientsToTemplateResponse>
  </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>
    <AddDocumentsRecipientsToTemplate xmlns="http://bulksign.com/">
      <authenticationToken>
        <UserEmail>string</UserEmail>
        <Key>string</Key>
      </authenticationToken>
      <model>
        <TemplateId>string</TemplateId>
        <Documents>
          <DocumentApiModel>
            <FileIdentifier xsi:nil="true" />
            <FileContentByteArray xsi:nil="true" />
            <FileContentBase64String xsi:nil="true" />
            <FileNetworkShare xsi:nil="true" />
            <FileName>string</FileName>
            <Index>int</Index>
            <FieldAssignments xsi:nil="true" />
            <NewSignatures xsi:nil="true" />
            <NewAnnotations xsi:nil="true" />
            <NewAttachments xsi:nil="true" />
            <NewTextBoxes xsi:nil="true" />
            <NewComboBoxes xsi:nil="true" />
            <NewCheckBoxes xsi:nil="true" />
            <OverwriteValues xsi:nil="true" />
          </DocumentApiModel>
          <DocumentApiModel>
            <FileIdentifier xsi:nil="true" />
            <FileContentByteArray xsi:nil="true" />
            <FileContentBase64String xsi:nil="true" />
            <FileNetworkShare xsi:nil="true" />
            <FileName>string</FileName>
            <Index>int</Index>
            <FieldAssignments xsi:nil="true" />
            <NewSignatures xsi:nil="true" />
            <NewAnnotations xsi:nil="true" />
            <NewAttachments xsi:nil="true" />
            <NewTextBoxes xsi:nil="true" />
            <NewComboBoxes xsi:nil="true" />
            <NewCheckBoxes xsi:nil="true" />
            <OverwriteValues xsi:nil="true" />
          </DocumentApiModel>
        </Documents>
        <Recipients>
          <RecipientApiModel>
            <Email>string</Email>
            <Name>string</Name>
            <Index>int</Index>
            <PersonalMessage>string</PersonalMessage>
            <RecipientAuthenticationMethods xsi:nil="true" />
            <RecipientType>Signer or ReceivesCopy or AutomaticSigner or Approver</RecipientType>
            <AutomaticSignerProfileIdentifier>string</AutomaticSignerProfileIdentifier>
          </RecipientApiModel>
          <RecipientApiModel>
            <Email>string</Email>
            <Name>string</Name>
            <Index>int</Index>
            <PersonalMessage>string</PersonalMessage>
            <RecipientAuthenticationMethods xsi:nil="true" />
            <RecipientType>Signer or ReceivesCopy or AutomaticSigner or Approver</RecipientType>
            <AutomaticSignerProfileIdentifier>string</AutomaticSignerProfileIdentifier>
          </RecipientApiModel>
        </Recipients>
      </model>
    </AddDocumentsRecipientsToTemplate>
  </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>
    <AddDocumentsRecipientsToTemplateResponse xmlns="http://bulksign.com/">
      <AddDocumentsRecipientsToTemplateResult>
        <ErrorMessage>string</ErrorMessage>
        <IsSuccessful>boolean</IsSuccessful>
        <Response>string</Response>
        <ErrorCode>int</ErrorCode>
        <RequestId>string</RequestId>
      </AddDocumentsRecipientsToTemplateResult>
    </AddDocumentsRecipientsToTemplateResponse>
  </soap12:Body>
</soap12:Envelope>