POST api/Documents/Archive?includeLinkedDocuments={includeLinkedDocuments}

Archive the documents with the specified identifiers.

Request Information

URI Parameters

Name	Description	Type	Additional information
includeLinkedDocuments	Whether or not linked documents should be archived	boolean	Default value is True

Body Parameters

The list of document identifiers.

Collection of integer

Request Formats

application/json, text/json

Sample:

[
  1,
  2
]

application/xml, text/xml

Sample:

<ArrayOflong xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <long>1</long>
  <long>2</long>
</ArrayOflong>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The result of the operation.

ESignSystems.Core.Results.OperationResult

Name	Type	Additional information
Succeeded	boolean	None.
Content	Object	None.
Errors	Collection of string	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.