POST api/SmartTransfer/Enable/Bulk

Provides the ability to enable a set of documents using a bulk list of document names as Electronic Transferable Documents.

Request Information

URI Parameters

None.

Body Parameters

The enable electronic transferable documents bulk model.

ESignSystems.SmartSAFE.Models.SmartTransfer.EnableElectronicTransferableDocumentsBulkModel
NameDescriptionTypeAdditional information
DocumentNames

Gets or sets the list of document names.

Collection of string

Required

ClientId

Gets or sets the client identifier.

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "DocumentNames": [
    "sample string 1",
    "sample string 2"
  ],
  "ClientId": 1
}

application/xml, text/xml

Sample:
<EnableElectronicTransferableDocumentsBulkModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <ClientId>1</ClientId>
  <DocumentNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DocumentNames>
</EnableElectronicTransferableDocumentsBulkModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Whether the job was successfully queued.

ESignSystems.Core.Results.OperationResult
NameDescriptionTypeAdditional information
Succeeded

boolean

None.

Content

Object

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.