POST api/SmartTransfer/AuthoritativeCopy

Provides the ability to perform actions that modify a document's Authoritative Copy status. Valid ActionTypeId values are: 5 = Designated, 6 = Exported, 7 = ConvertedToPaper.

Request Information

URI Parameters

None.

Body Parameters

Model that represent the document(s) and action to be performed.

ESignSystems.SmartSAFE.Models.SmartTransfer.AuthoritativeCopyActionRequestModel

Name	Description	Type	Additional information
DocumentIDs	Gets or sets the list of document identifiers that should have the given action performed on them.	Collection of integer	None.
ActionTypeId	Gets or sets the identifier for the Authoritative Copy modifying action the given documents should have performed.	integer	Required
ClientId	Gets or sets the client identifier that the given document IDs belong to.	integer	Required
MarkAsElectronicTransferableDocument	Gets or sets a value indicating whether the documents in this request should be marked as Electronic Transferable Documents.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentIDs": [
    1,
    2
  ],
  "ActionTypeId": 1,
  "ClientId": 1,
  "MarkAsElectronicTransferableDocument": true
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of models that represents how applying the requested Authoritative Copy action to the given documents went.

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>