POST api/Documents/ClientToClientTransfer/Send

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

Request Information

URI Parameters

None.

Body Parameters

Model containg information for performing a transfer using Document IDs.

ESignSystems.SmartSAFE.Models.Documents.ClientToClientTransferModel

Name	Description	Type	Additional information
Documents	The list of documents to transfer.	Collection of ESignSystems.SmartSAFE.Models.Documents.ClientToClientTransferParentDocumentModel	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:

{
  "Documents": [
    {
      "Children": [
        {
          "DocumentId": 1
        },
        {
          "DocumentId": 1
        }
      ],
      "DocumentId": 1
    },
    {
      "Children": [
        {
          "DocumentId": 1
        },
        {
          "DocumentId": 1
        }
      ],
      "DocumentId": 1
    }
  ],
  "SendingClientId": 1,
  "ReceivingClientId": 2,
  "LeaveCopyOfDocuments": true
}

application/xml, text/xml

Sample:

<ClientToClientTransferModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Documents">
  <LeaveCopyOfDocuments>true</LeaveCopyOfDocuments>
  <ReceivingClientId>2</ReceivingClientId>
  <SendingClientId>1</SendingClientId>
  <Documents>
    <ClientToClientTransferParentDocumentModel>
      <DocumentId>1</DocumentId>
      <Children>
        <ClientToClientTransferDocumentModel>
          <DocumentId>1</DocumentId>
        </ClientToClientTransferDocumentModel>
        <ClientToClientTransferDocumentModel>
          <DocumentId>1</DocumentId>
        </ClientToClientTransferDocumentModel>
      </Children>
    </ClientToClientTransferParentDocumentModel>
    <ClientToClientTransferParentDocumentModel>
      <DocumentId>1</DocumentId>
      <Children>
        <ClientToClientTransferDocumentModel>
          <DocumentId>1</DocumentId>
        </ClientToClientTransferDocumentModel>
        <ClientToClientTransferDocumentModel>
          <DocumentId>1</DocumentId>
        </ClientToClientTransferDocumentModel>
      </Children>
    </ClientToClientTransferParentDocumentModel>
  </Documents>
</ClientToClientTransferModel>

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.