POST api/SmartTransfer/AuthoritativeCopy/Import

Provides the ability to import an Authoritative Copy document into a Client's eVault.

Request Information

URI Parameters

None.

Body Parameters

The model that represents the document to import.

ESignSystems.SmartSAFE.Models.SmartTransfer.ImportAuthoritativeCopyDocumentModel

Name	Description	Type	Additional information
ClientId	Gets or sets the client id for the document.	integer	None.
FolderId	Gets or sets the folder identifier that the document will be imported into.	integer	None.
File	Gets or sets a byte array representing the file.	Collection of byte	Required
FileName	Gets or sets the file name of the document.	string	Required Max length: 256
DocumentName	Gets or sets the name of the document.	string	Required Max length: 150
DocumentTypeId	Gets or sets the document type identifier for the document.	integer	None.
UDF1	Gets or sets the first User Defined Field for the document.	string	Max length: 256
UDF2	Gets or sets the second User Defined Field for the document.	string	Max length: 256
UDF3	Gets or sets the third User Defined Field for the document.	string	Max length: 256
TransferableRecord	Gets or sets the transferable record flag for the document.	boolean	None.
PreviousSecuredParty	Gets or sets the previous secured party for the document.	string	Required Max length: 256

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "FolderId": 1,
  "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:

<ImportAuthoritativeCopyDocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <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>
  <ClientId>1</ClientId>
  <FolderId>1</FolderId>
</ImportAuthoritativeCopyDocumentModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentId of the Authoritative Copy document that was imported.

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"
}

application/xml, text/xml

Sample:

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