POST api/SmartRegistry/Reports/Batch

Gets a list of eRegistry batch DTOs based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The search criteria.

ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.ERegistryBatchSearchCriteria

Name	Description	Type	Additional information
ClientId	Gets or sets the client identifier.	integer	None.
ERegistryBatchId	Gets or sets the eRegistry batch identifier.	integer	None.
MIN	Gets or sets the MIN.	string	None.
RecipientMERSOrgId	Gets or sets the recipient MERS organization identifier.	string	None.
ERegistryBatchStatusTypeId	Gets or sets the eRegistry batch status.	integer	None.
ERegistryBatchTypeId	Gets or sets the ERegistryBatch TypeId	integer	None.
StartDate	Gets or sets the start date.	date	Required
EndDate	Gets or sets the end date.	date	Required
PageSize	Gets or sets the number of rows in the page.	integer	Range: inclusive between 1 and 2147483647
PageOffset	Gets or sets the offset page to return.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "ERegistryBatchId": 1,
  "MIN": "sample string 1",
  "RecipientMERSOrgId": "sample string 2",
  "ERegistryBatchStatusTypeId": 1,
  "ERegistryBatchTypeId": 1,
  "StartDate": "2024-11-26T17:42:27.8426958-05:00",
  "EndDate": "2024-11-26T17:42:27.8426958-05:00",
  "PageSize": 1,
  "PageOffset": 3
}

application/xml, text/xml

Sample:

<ERegistryBatchSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry.Reports">
  <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">3</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <ClientId>1</ClientId>
  <ERegistryBatchId>1</ERegistryBatchId>
  <ERegistryBatchStatusTypeId>1</ERegistryBatchStatusTypeId>
  <ERegistryBatchTypeId>1</ERegistryBatchTypeId>
  <EndDate>2024-11-26T17:42:27.8426958-05:00</EndDate>
  <MIN>sample string 1</MIN>
  <RecipientMERSOrgId>sample string 2</RecipientMERSOrgId>
  <StartDate>2024-11-26T17:42:27.8426958-05:00</StartDate>
</ERegistryBatchSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of eRegistry batch DTOs.

Collection of 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:42:27.8426958-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:42:27.8426958-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:42:27.8426958-05:00"
      }
    ],
    "UpdatedBy": "sample string 5",
    "UpdatedDate": "2024-11-26T17:42:27.8426958-05:00"
  },
  {
    "ERegistryBatchId": 1,
    "ERegistryBatchTypeId": 1,
    "ERegistryBatchType": "sample string 1",
    "Status": "sample string 2",
    "Recipients": "sample string 3",
    "StartTime": "2024-11-26T17:42:27.8426958-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:42:27.8426958-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:42:27.8426958-05:00"
      }
    ],
    "UpdatedBy": "sample string 5",
    "UpdatedDate": "2024-11-26T17:42:27.8426958-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfERegistryBatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <ERegistryBatchModel>
    <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:42:27.8426958-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:42:27.8426958-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:42:27.8426958-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:42:27.8426958-05:00</StartTime>
    <Status>sample string 2</Status>
  </ERegistryBatchModel>
  <ERegistryBatchModel>
    <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:42:27.8426958-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:42:27.8426958-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:42:27.8426958-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:42:27.8426958-05:00</StartTime>
    <Status>sample string 2</Status>
  </ERegistryBatchModel>
</ArrayOfERegistryBatchModel>