GET api/SmartRegistry/eNote/Batch/{eRegistryBatchId}

Gets the eRegistry batch.

Request Information

URI Parameters

Name	Description	Type	Additional information
eRegistryBatchId	The eRegistry batch identifier.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The eRegistry batch model.

ESignSystems.SmartSAFE.Models.SmartRegistry.ERegistryBatchModel

Name	Description	Type	Additional information
ERegistryBatchId	Gets or sets the eRegistry batch identifier.	integer	None.
ERegistryBatchTypeId	Gets or sets the eRegistry batch type identifier.	integer	None.
ERegistryBatchType	Gets or sets the eRegistry batch type.	string	None.
Status	Gets or sets the status.	string	None.
Recipients	Gets or sets the recipients.	string	None.
StartTime	Gets or sets the start time.	date	None.
Responses	Gets or sets the responses.	Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.ERegistryBatchResponseModel	None.
UpdatedBy	Gets or sets the name of the user that updated the model.	string	None.
UpdatedDate	Gets or sets the date an time that the model was updated.	date	None.

Response Formats

application/json, text/json

Sample:

{
  "ERegistryBatchId": 1,
  "ERegistryBatchTypeId": 1,
  "ERegistryBatchType": "sample string 1",
  "Status": "sample string 2",
  "Recipients": "sample string 3",
  "StartTime": "2024-11-26T17:41:26.1666521-05:00",
  "Responses": [
    {
      "MIN": "sample string 1",
      "DocumentName": "sample string 2",
      "Success": true,
      "TrackingNumber": "sample string 4",
      "TransferIdentifier": "sample string 5",
      "StatusDescription": "sample string 6",
      "UpdatedBy": "sample string 7",
      "UpdatedDate": "2024-11-26T17:41:26.1666521-05:00"
    },
    {
      "MIN": "sample string 1",
      "DocumentName": "sample string 2",
      "Success": true,
      "TrackingNumber": "sample string 4",
      "TransferIdentifier": "sample string 5",
      "StatusDescription": "sample string 6",
      "UpdatedBy": "sample string 7",
      "UpdatedDate": "2024-11-26T17:41:26.1666521-05:00"
    }
  ],
  "UpdatedBy": "sample string 5",
  "UpdatedDate": "2024-11-26T17:41:26.1666521-05:00"
}

application/xml, text/xml

Sample:

<ERegistryBatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 5</UpdatedBy>
  <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:41:26.1666521-05:00</UpdatedDate>
  <ERegistryBatchId>1</ERegistryBatchId>
  <ERegistryBatchType>sample string 1</ERegistryBatchType>
  <ERegistryBatchTypeId>1</ERegistryBatchTypeId>
  <Recipients>sample string 3</Recipients>
  <Responses>
    <ERegistryBatchResponseModel>
      <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 7</UpdatedBy>
      <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:41:26.1666521-05:00</UpdatedDate>
      <DocumentName>sample string 2</DocumentName>
      <MIN>sample string 1</MIN>
      <StatusDescription>sample string 6</StatusDescription>
      <Success>true</Success>
      <TrackingNumber>sample string 4</TrackingNumber>
      <TransferIdentifier>sample string 5</TransferIdentifier>
    </ERegistryBatchResponseModel>
    <ERegistryBatchResponseModel>
      <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 7</UpdatedBy>
      <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:41:26.1666521-05:00</UpdatedDate>
      <DocumentName>sample string 2</DocumentName>
      <MIN>sample string 1</MIN>
      <StatusDescription>sample string 6</StatusDescription>
      <Success>true</Success>
      <TrackingNumber>sample string 4</TrackingNumber>
      <TransferIdentifier>sample string 5</TransferIdentifier>
    </ERegistryBatchResponseModel>
  </Responses>
  <StartTime>2024-11-26T17:41:26.1666521-05:00</StartTime>
  <Status>sample string 2</Status>
</ERegistryBatchModel>