POST api/SmartRegistry/eNote/ChangeData/VaultId

Provides the ability to update the vault ids for eNotes.

Request Information

URI Parameters

None.

Body Parameters

The eNote document and Vault Id information.

ESignSystems.SmartSAFE.Models.SmartRegistry.UpdateVaultIdRequest
NameDescriptionTypeAdditional information
Documents

Gets or sets a list of eNotes.

Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.DocumentVaultId

None.

ClientId

Gets or sets the client identifier.

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Documents": [
    {
      "DocumentId": 1,
      "VaultId": "sample string 1"
    },
    {
      "DocumentId": 1,
      "VaultId": "sample string 1"
    }
  ],
  "ClientId": 1
}

application/xml, text/xml

Sample:
<UpdateVaultIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <ClientId>1</ClientId>
  <Documents>
    <DocumentVaultId>
      <DocumentId>1</DocumentId>
      <VaultId>sample string 1</VaultId>
    </DocumentVaultId>
    <DocumentVaultId>
      <DocumentId>1</DocumentId>
      <VaultId>sample string 1</VaultId>
    </DocumentVaultId>
  </Documents>
</UpdateVaultIdRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ESignSystems.ERegistry.Models.ResponseModel
NameDescriptionTypeAdditional information
MIN

string

None.

DocumentName

string

None.

Success

boolean

None.

ResponseMessages

Collection of ESignSystems.ERegistry.Models.ResponseMessageModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "MIN": "sample string 1",
    "DocumentName": "sample string 2",
    "Success": true,
    "ResponseMessages": [
      {
        "MIN": "sample string 1",
        "StatusCode": "sample string 2",
        "StatusName": "sample string 3",
        "StatusDescription": "sample string 4",
        "Success": true,
        "TransferIdentifier": "sample string 6",
        "TrackingNumber": "sample string 7",
        "Error": true
      },
      {
        "MIN": "sample string 1",
        "StatusCode": "sample string 2",
        "StatusName": "sample string 3",
        "StatusDescription": "sample string 4",
        "Success": true,
        "TransferIdentifier": "sample string 6",
        "TrackingNumber": "sample string 7",
        "Error": true
      }
    ]
  },
  {
    "MIN": "sample string 1",
    "DocumentName": "sample string 2",
    "Success": true,
    "ResponseMessages": [
      {
        "MIN": "sample string 1",
        "StatusCode": "sample string 2",
        "StatusName": "sample string 3",
        "StatusDescription": "sample string 4",
        "Success": true,
        "TransferIdentifier": "sample string 6",
        "TrackingNumber": "sample string 7",
        "Error": true
      },
      {
        "MIN": "sample string 1",
        "StatusCode": "sample string 2",
        "StatusName": "sample string 3",
        "StatusDescription": "sample string 4",
        "Success": true,
        "TransferIdentifier": "sample string 6",
        "TrackingNumber": "sample string 7",
        "Error": true
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.ERegistry.Models">
  <ResponseModel>
    <DocumentName>sample string 2</DocumentName>
    <MIN>sample string 1</MIN>
    <ResponseMessages>
      <ResponseMessageModel>
        <Error>true</Error>
        <MIN>sample string 1</MIN>
        <StatusCode>sample string 2</StatusCode>
        <StatusDescription>sample string 4</StatusDescription>
        <StatusName>sample string 3</StatusName>
        <Success>true</Success>
        <TrackingNumber>sample string 7</TrackingNumber>
        <TransferIdentifier>sample string 6</TransferIdentifier>
      </ResponseMessageModel>
      <ResponseMessageModel>
        <Error>true</Error>
        <MIN>sample string 1</MIN>
        <StatusCode>sample string 2</StatusCode>
        <StatusDescription>sample string 4</StatusDescription>
        <StatusName>sample string 3</StatusName>
        <Success>true</Success>
        <TrackingNumber>sample string 7</TrackingNumber>
        <TransferIdentifier>sample string 6</TransferIdentifier>
      </ResponseMessageModel>
    </ResponseMessages>
    <Success>true</Success>
  </ResponseModel>
  <ResponseModel>
    <DocumentName>sample string 2</DocumentName>
    <MIN>sample string 1</MIN>
    <ResponseMessages>
      <ResponseMessageModel>
        <Error>true</Error>
        <MIN>sample string 1</MIN>
        <StatusCode>sample string 2</StatusCode>
        <StatusDescription>sample string 4</StatusDescription>
        <StatusName>sample string 3</StatusName>
        <Success>true</Success>
        <TrackingNumber>sample string 7</TrackingNumber>
        <TransferIdentifier>sample string 6</TransferIdentifier>
      </ResponseMessageModel>
      <ResponseMessageModel>
        <Error>true</Error>
        <MIN>sample string 1</MIN>
        <StatusCode>sample string 2</StatusCode>
        <StatusDescription>sample string 4</StatusDescription>
        <StatusName>sample string 3</StatusName>
        <Success>true</Success>
        <TrackingNumber>sample string 7</TrackingNumber>
        <TransferIdentifier>sample string 6</TransferIdentifier>
      </ResponseMessageModel>
    </ResponseMessages>
    <Success>true</Success>
  </ResponseModel>
</ArrayOfResponseModel>