POST api/SmartTransfer/Enable

Provides the ability to enable a set of documents as Electronic Transferable Documents.

Request Information

URI Parameters

None.

Body Parameters

The enable electronic transferable documents model.

ESignSystems.SmartSAFE.Models.SmartTransfer.EnableElectronicTransferableDocumentsModel

Name	Description	Type	Additional information
DocumentIds	Gets or sets the list of document identifiers.	Collection of integer	Required
ClientId	Gets or sets the client identifier.	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "DocumentIds": [
    1,
    2
  ],
  "ClientId": 1
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result of the operation.

Collection of ESignSystems.SmartSAFE.Models.SmartTransfer.AuthoritativeCopyActionResponseModel

Name	Description	Type	Additional information
DocumentId	Gets or sets the document identifier for this response.	integer	None.
DocumentName	Gets or sets the document name for this response.	string	None.
TransactionIdentifier	Gets or sets the transaction identifier.	string	None.
Success	Gets or sets a flag that represents whether this document was successful in having the relevant Authoritative Copy modifying action performed on it.	boolean	None.
Message	Gets or sets the message that goes along with this response that represents what happened	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentId": 1,
    "DocumentName": "sample string 1",
    "TransactionIdentifier": "sample string 2",
    "Success": true,
    "Message": "sample string 3"
  },
  {
    "DocumentId": 1,
    "DocumentName": "sample string 1",
    "TransactionIdentifier": "sample string 2",
    "Success": true,
    "Message": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAuthoritativeCopyActionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <AuthoritativeCopyActionResponseModel>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 1</DocumentName>
    <Message>sample string 3</Message>
    <Success>true</Success>
    <TransactionIdentifier>sample string 2</TransactionIdentifier>
  </AuthoritativeCopyActionResponseModel>
  <AuthoritativeCopyActionResponseModel>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 1</DocumentName>
    <Message>sample string 3</Message>
    <Success>true</Success>
    <TransactionIdentifier>sample string 2</TransactionIdentifier>
  </AuthoritativeCopyActionResponseModel>
</ArrayOfAuthoritativeCopyActionResponseModel>