POST api/SmartTransfer/AuthoritativeCopy/Import/Bulk

Provides the ability to import multiple Authoritative Copy documents into a Client's eVault.

Request Information

URI Parameters

None.

Body Parameters

The import authoritative copy document bulk model.

ESignSystems.SmartSAFE.Models.SmartTransfer.ImportAuthoritativeCopyDocumentBulkModel
NameDescriptionTypeAdditional information
ClientId

Gets or sets the client identifier.

integer

None.

FolderId

Gets or sets the folder identifier that the documents will be imported into.

integer

None.

Documents

Gets or sets the list of import document models.

Collection of ESignSystems.SmartSAFE.Models.SmartTransfer.ImportAuthoritativeCopyDocumentBaseModel

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientId": 1,
  "FolderId": 1,
  "Documents": [
    {
      "File": "QEA=",
      "FileName": "sample string 1",
      "DocumentName": "sample string 2",
      "DocumentTypeId": 1,
      "UDF1": "sample string 3",
      "UDF2": "sample string 4",
      "UDF3": "sample string 5",
      "TransferableRecord": true,
      "PreviousSecuredParty": "sample string 7"
    },
    {
      "File": "QEA=",
      "FileName": "sample string 1",
      "DocumentName": "sample string 2",
      "DocumentTypeId": 1,
      "UDF1": "sample string 3",
      "UDF2": "sample string 4",
      "UDF3": "sample string 5",
      "TransferableRecord": true,
      "PreviousSecuredParty": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:
<ImportAuthoritativeCopyDocumentBulkModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <ClientId>1</ClientId>
  <Documents>
    <ImportAuthoritativeCopyDocumentBaseModel>
      <DocumentName>sample string 2</DocumentName>
      <DocumentTypeId>1</DocumentTypeId>
      <File>QEA=</File>
      <FileName>sample string 1</FileName>
      <PreviousSecuredParty>sample string 7</PreviousSecuredParty>
      <TransferableRecord>true</TransferableRecord>
      <UDF1>sample string 3</UDF1>
      <UDF2>sample string 4</UDF2>
      <UDF3>sample string 5</UDF3>
    </ImportAuthoritativeCopyDocumentBaseModel>
    <ImportAuthoritativeCopyDocumentBaseModel>
      <DocumentName>sample string 2</DocumentName>
      <DocumentTypeId>1</DocumentTypeId>
      <File>QEA=</File>
      <FileName>sample string 1</FileName>
      <PreviousSecuredParty>sample string 7</PreviousSecuredParty>
      <TransferableRecord>true</TransferableRecord>
      <UDF1>sample string 3</UDF1>
      <UDF2>sample string 4</UDF2>
      <UDF3>sample string 5</UDF3>
    </ImportAuthoritativeCopyDocumentBaseModel>
  </Documents>
  <FolderId>1</FolderId>
</ImportAuthoritativeCopyDocumentBulkModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The success or failure of enqueuing the bulk job.

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.