POST api/Documents/ClientToClientTransfer/Send/Bulk

Provides the ability to perform a client to client transfer using Document Names.

Request Information

URI Parameters

None.

Body Parameters

Model containg information for performing a transfer using Document Names.

ESignSystems.SmartSAFE.Models.Documents.ClientToClientBulkTransferModel

Name	Description	Type	Additional information
IncludeLinked	Indicates whether to include linked documents for each document when doing the client to client transfer.	boolean	None.
DocumentNames	The list of documents to transfer.	Collection of string	None.
SendingClientId	The sending client identifier.	integer	Required
ReceivingClientId	The receiving client identifier.	integer	Required
LeaveCopyOfDocuments	Indicates whether to leave a copy of the documents behind after the transfer.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "IncludeLinked": true,
  "DocumentNames": [
    "sample string 1",
    "sample string 2"
  ],
  "SendingClientId": 2,
  "ReceivingClientId": 3,
  "LeaveCopyOfDocuments": true
}

application/xml, text/xml

Sample:

<ClientToClientBulkTransferModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Documents">
  <LeaveCopyOfDocuments>true</LeaveCopyOfDocuments>
  <ReceivingClientId>3</ReceivingClientId>
  <SendingClientId>2</SendingClientId>
  <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>
  <IncludeLinked>true</IncludeLinked>
</ClientToClientBulkTransferModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The result of enqueueing the transfer to be processed asynchronously.

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.