POST api/SigningRoomManager/Documents/UploadSmartDocument

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.SigningRoomSmartDocumentFileUploadModel

Name	Description	Type	Additional information
SigningRoomId	Gets or sets the SigningRoom identifier of the SigningRoom where the file is being uploaded.	integer	Required
SmartDocumentBorrowers	Gets or sets a list of smart documents.	Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.UploadBorrowerModel	None.
SmartDocumentRegistrationSettings	Gets or sets the smart document registration settings information.	ESignSystems.SmartSAFE.Models.SmartDocuments.SmartDocumentRegistrationSettingsModel	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,
  "SmartDocumentBorrowers": [
    {
      "SSN": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "NameSuffix": "sample string 5",
      "DocumentName": "sample string 6",
      "FullName": "sample string 2 sample string 3 sample string 4 sample string 5"
    },
    {
      "SSN": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "NameSuffix": "sample string 5",
      "DocumentName": "sample string 6",
      "FullName": "sample string 2 sample string 3 sample string 4 sample string 5"
    }
  ],
  "SmartDocumentRegistrationSettings": {
    "SmartDocumentRegistrationSettingsId": 1,
    "RegistrationMethodId": 1,
    "RegistrationTypeId": 1,
    "ServicerMERSOrgId": "sample string 1",
    "ControllerMERSOrgId": "sample string 2",
    "LocationMERSOrgId": "sample string 3",
    "DelegateeForTransferMERSOrgId": "sample string 4",
    "SecuredPartyMERSOrgId": "sample string 5",
    "SecuredPartyDelegateeMERSOrgId": "sample string 6"
  },
  "DocumentName": "sample string 1",
  "FileName": "sample string 2",
  "ClientId": 1,
  "FolderId": 1,
  "DocumentTypeId": 1,
  "UDF1": "sample string 3",
  "UDF2": "sample string 4",
  "UDF3": "sample string 5",
  "File": "QEA=",
  "PrintAndSign": true,
  "ENotary": true,
  "TransferableRecord": true,
  "ParentDocumentId": 1,
  "Description": "sample string 9"
}

application/xml, text/xml

Sample:

<SigningRoomSmartDocumentFileUploadModel 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 9</Description>
  <DocumentName>sample string 1</DocumentName>
  <DocumentTypeId>1</DocumentTypeId>
  <ENotary>true</ENotary>
  <File>QEA=</File>
  <FileName>sample string 2</FileName>
  <FolderId>1</FolderId>
  <ParentDocumentId>1</ParentDocumentId>
  <PrintAndSign>true</PrintAndSign>
  <TransferableRecord>true</TransferableRecord>
  <UDF1>sample string 3</UDF1>
  <UDF2>sample string 4</UDF2>
  <UDF3>sample string 5</UDF3>
  <SmartDocumentBorrowers xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartDocuments">
    <d2p1:UploadBorrowerModel>
      <d2p1:DocumentName>sample string 6</d2p1:DocumentName>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 4</d2p1:LastName>
      <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
      <d2p1:NameSuffix>sample string 5</d2p1:NameSuffix>
      <d2p1:SSN>sample string 1</d2p1:SSN>
    </d2p1:UploadBorrowerModel>
    <d2p1:UploadBorrowerModel>
      <d2p1:DocumentName>sample string 6</d2p1:DocumentName>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 4</d2p1:LastName>
      <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
      <d2p1:NameSuffix>sample string 5</d2p1:NameSuffix>
      <d2p1:SSN>sample string 1</d2p1:SSN>
    </d2p1:UploadBorrowerModel>
  </SmartDocumentBorrowers>
  <SmartDocumentRegistrationSettings xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartDocuments">
    <ControllerMERSOrgId>sample string 2</ControllerMERSOrgId>
    <DelegateeForTransferMERSOrgId>sample string 4</DelegateeForTransferMERSOrgId>
    <LocationMERSOrgId>sample string 3</LocationMERSOrgId>
    <RegistrationMethodId>1</RegistrationMethodId>
    <RegistrationTypeId>1</RegistrationTypeId>
    <SecuredPartyDelegateeMERSOrgId>sample string 6</SecuredPartyDelegateeMERSOrgId>
    <SecuredPartyMERSOrgId>sample string 5</SecuredPartyMERSOrgId>
    <ServicerMERSOrgId>sample string 1</ServicerMERSOrgId>
    <SmartDocumentRegistrationSettingsId>1</SmartDocumentRegistrationSettingsId>
  </SmartDocumentRegistrationSettings>
  <SigningRoomId>1</SigningRoomId>
</SigningRoomSmartDocumentFileUploadModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The new document's identifier.

Collection of ESignSystems.SmartSAFE.Models.SmartDocuments.SmartDocumentUploadResult

Name	Description	Type	Additional information
DocumentId	Gets or sets the document id.	integer	None.
SmartDocumentId	Gets or sets the smart document id.	integer	None.
MIN	Gets or sets the MIN.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentId": 1,
    "SmartDocumentId": 1,
    "MIN": "sample string 1"
  },
  {
    "DocumentId": 1,
    "SmartDocumentId": 1,
    "MIN": "sample string 1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSmartDocumentUploadResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartDocuments">
  <SmartDocumentUploadResult>
    <DocumentId>1</DocumentId>
    <MIN>sample string 1</MIN>
    <SmartDocumentId>1</SmartDocumentId>
  </SmartDocumentUploadResult>
  <SmartDocumentUploadResult>
    <DocumentId>1</DocumentId>
    <MIN>sample string 1</MIN>
    <SmartDocumentId>1</SmartDocumentId>
  </SmartDocumentUploadResult>
</ArrayOfSmartDocumentUploadResult>