POST api/SigningRoomManager/Documents/Upload

Allows a client admin or a SigningRoom admin to upload a document to a SigningRoom.

Request Information

URI Parameters

None.

Body Parameters

The upload document data.

ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomFileUploadModel

Name	Description	Type	Additional information
SigningRoomId	Gets or sets the SigningRoom identifier of the SigningRoom where the file is being uploaded.	integer	None.
ExternallySigned	Gets or sets a value indicating whether the document being uploaded has been signed externally.	boolean	None.
MarkAsAuthoritativeCopyAfterSigning	Gets or sets a value indicating whether the document being uploaded will become AuthoritativeCopy after it's finished being signed in a SigningRoom.	boolean	None.
DocumentName	Gets or sets the name of the document being uploaded.	string	Max length: 256
FileName	Gets or sets the file name of the document being uploaded.	string	Max length: 256
ClientId	Gets or sets the ID of the client uploading the file.	integer	None.
FolderId	Gets or sets the folder identifier.	integer	None.
DocumentTypeId	Gets or sets the document's document type identifier.	integer	None.
UDF1	Gets or sets the first User Defined Field identifying the document.	string	Max length: 256
UDF2	Gets or sets the second User Defined Field identifying the document.	string	Max length: 256
UDF3	Gets or sets the third User Defined Field identifying the document.	string	Max length: 256
File	Gets or sets a byte array represting the file being uploaded.	Collection of byte	Required
PrintAndSign	Gets or sets the print and sign flag.	boolean	None.
ENotary	Gets or sets the eNotary flag.	boolean	None.
TransferableRecord	Gets or sets the transferable record flag.	boolean	None.
ParentDocumentId	Gets or sets the parent document identifier.	integer	None.
Description	Gets or sets the description.	string	Max length: 500

Request Formats

application/json, text/json

Sample:

{
  "SigningRoomId": 1,
  "ExternallySigned": true,
  "MarkAsAuthoritativeCopyAfterSigning": true,
  "DocumentName": "sample string 4",
  "FileName": "sample string 5",
  "ClientId": 1,
  "FolderId": 1,
  "DocumentTypeId": 1,
  "UDF1": "sample string 6",
  "UDF2": "sample string 7",
  "UDF3": "sample string 8",
  "File": "QEA=",
  "PrintAndSign": true,
  "ENotary": true,
  "TransferableRecord": true,
  "ParentDocumentId": 1,
  "Description": "sample string 12"
}

application/xml, text/xml

Sample:

<SigningRoomFileUploadModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
  <ClientId>1</ClientId>
  <Description>sample string 12</Description>
  <DocumentName>sample string 4</DocumentName>
  <DocumentTypeId>1</DocumentTypeId>
  <ENotary>true</ENotary>
  <File>QEA=</File>
  <FileName>sample string 5</FileName>
  <FolderId>1</FolderId>
  <ParentDocumentId>1</ParentDocumentId>
  <PrintAndSign>true</PrintAndSign>
  <TransferableRecord>true</TransferableRecord>
  <UDF1>sample string 6</UDF1>
  <UDF2>sample string 7</UDF2>
  <UDF3>sample string 8</UDF3>
  <ExternallySigned>true</ExternallySigned>
  <MarkAsAuthoritativeCopyAfterSigning>true</MarkAsAuthoritativeCopyAfterSigning>
  <SigningRoomId>1</SigningRoomId>
</SigningRoomFileUploadModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The new document's identifier.

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<long xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</long>