POST api/SmartRegistry/eNote/ChangeData/Modification

Provides the ability to manage the modification request.

Request Information

URI Parameters

None.

Body Parameters

The modificationRequest.

ESignSystems.SmartSAFE.Models.SmartRegistry.ModificationRequest

Name	Description	Type	Additional information
Documents	Gets or sets the list of documents.	Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.ModificationDocument	None.
ModificationType	Gets or sets the modification type.	string	None.
ClientId	Gets or sets the client identifier.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Documents": [
    {
      "TargetDocumentId": 1,
      "ModificationDocumentId": 1
    },
    {
      "TargetDocumentId": 1,
      "ModificationDocumentId": 1
    }
  ],
  "ModificationType": "sample string 1",
  "ClientId": 1
}

application/xml, text/xml

Sample:

<ModificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <ClientId>1</ClientId>
  <Documents>
    <ModificationDocument>
      <ModificationDocumentId>1</ModificationDocumentId>
      <TargetDocumentId>1</TargetDocumentId>
    </ModificationDocument>
    <ModificationDocument>
      <ModificationDocumentId>1</ModificationDocumentId>
      <TargetDocumentId>1</TargetDocumentId>
    </ModificationDocument>
  </Documents>
  <ModificationType>sample string 1</ModificationType>
</ModificationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ESignSystems.ERegistry.Models.ResponseModel

Name	Type	Additional 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>