POST api/SmartTransfer/Send

Provides the ability to send/transfer a set of documents to another client.

Request Information

URI Parameters

None.

Body Parameters

Model containing the list of documents to send.

ESignSystems.SmartSAFE.Models.SmartTransfer.SendTransferRequestModel

Name	Description	Type	Additional information
TransferDocuments	Gets or sets the document transfer documents.	Collection of ESignSystems.SmartSAFE.Models.SmartTransfer.TransferRequestDocumentModel	None.
TransferPartnerId	Gets or sets the transfer partner id.	integer	Required
ClientId	Gets or sets the client id.	integer	None.
IncludeUserDefinedFields	Gets or sets a value indicating whether to include the documents' UDF values in the transfer.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "TransferDocuments": [
    {
      "AuthoritativeCopyDocumentId": 1,
      "AncillaryDocumentIds": [
        1,
        2
      ]
    },
    {
      "AuthoritativeCopyDocumentId": 1,
      "AncillaryDocumentIds": [
        1,
        2
      ]
    }
  ],
  "TransferPartnerId": 1,
  "ClientId": 1,
  "IncludeUserDefinedFields": true
}

application/xml, text/xml

Sample:

<SendTransferRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <ClientId>1</ClientId>
  <IncludeUserDefinedFields>true</IncludeUserDefinedFields>
  <TransferPartnerId>1</TransferPartnerId>
  <TransferDocuments>
    <TransferRequestDocumentModel>
      <AncillaryDocumentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </AncillaryDocumentIds>
      <AuthoritativeCopyDocumentId>1</AuthoritativeCopyDocumentId>
    </TransferRequestDocumentModel>
    <TransferRequestDocumentModel>
      <AncillaryDocumentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </AncillaryDocumentIds>
      <AuthoritativeCopyDocumentId>1</AuthoritativeCopyDocumentId>
    </TransferRequestDocumentModel>
  </TransferDocuments>
</SendTransferRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The responses from the transfer.

Collection of ESignSystems.SmartSAFE.Models.SmartTransfer.SendTransferResponseModel

Name	Description	Type	Additional information
Message	The response message for the transfer.	string	None.
ParentDocumentName	Gets or sets the parents document name for this document in the transfer	string	None.
NewDocumentId	The new document's identifier.	integer	None.
AuthoritativeCopy	Gets or sets a value indicating whether or not the document is an authoritative copy.	boolean	None.
TransactionIdentifier	Gets or sets the transaction identifier.	string	None.
DocumentId	Gets or sets the document identifier.	integer	None.
DocumentName	Gets or sets the document name.	string	None.
Success	Gets or sets a value indicating whether the Transfer request was successful for this document.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Message": "sample string 1",
    "ParentDocumentName": "sample string 2",
    "NewDocumentId": 1,
    "AuthoritativeCopy": true,
    "TransactionIdentifier": "sample string 4",
    "DocumentId": 1,
    "DocumentName": "sample string 5",
    "Success": true
  },
  {
    "Message": "sample string 1",
    "ParentDocumentName": "sample string 2",
    "NewDocumentId": 1,
    "AuthoritativeCopy": true,
    "TransactionIdentifier": "sample string 4",
    "DocumentId": 1,
    "DocumentName": "sample string 5",
    "Success": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfSendTransferResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <SendTransferResponseModel>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 5</DocumentName>
    <Success>true</Success>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <Message>sample string 1</Message>
    <NewDocumentId>1</NewDocumentId>
    <ParentDocumentName>sample string 2</ParentDocumentName>
    <TransactionIdentifier>sample string 4</TransactionIdentifier>
  </SendTransferResponseModel>
  <SendTransferResponseModel>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 5</DocumentName>
    <Success>true</Success>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <Message>sample string 1</Message>
    <NewDocumentId>1</NewDocumentId>
    <ParentDocumentName>sample string 2</ParentDocumentName>
    <TransactionIdentifier>sample string 4</TransactionIdentifier>
  </SendTransferResponseModel>
</ArrayOfSendTransferResponseModel>