POST api/SmartRegistry/Reports/eDelivery/Download

Download a CSV file of eDelivery requests based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The eDelivery request search criteria model.

ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.EDeliveryRequestSearchCriteria

Name	Description	Type	Additional information
TrackingNumber	Gets or sets the tracking number.	string	None.
ClientId	Gets or sets the client identifier.	integer	None.
DocumentName	Gets or sets the document name.	string	None.
MIN	Gets or sets the min.	string	None.
StartDate	Gets or sets the start date.	date	Required
EndDate	Gets or sets the end date.	date	Required
ERegistryTransactionRequestTypeId	Gets or sets the eRegistryTransactionRequestTypeId.	integer	None.
ERegistryRequestStatusTypeId	Gets or sets the eRegistryRequestStatusTypeId.	integer	None.
ERegistryBatchId	Gets or sets the eRegistry batch identifier.	integer	None.
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:

{
  "TrackingNumber": "sample string 1",
  "ClientId": 1,
  "DocumentName": "sample string 2",
  "MIN": "sample string 3",
  "StartDate": "2024-11-26T17:13:32.1952435-05:00",
  "EndDate": "2024-11-26T17:13:32.1952435-05:00",
  "ERegistryTransactionRequestTypeId": 1,
  "ERegistryRequestStatusTypeId": 1,
  "ERegistryBatchId": 1,
  "PageSize": 1,
  "PageOffset": 4
}

application/xml, text/xml

Sample:

<EDeliveryRequestSearchCriteria 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">4</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <ClientId>1</ClientId>
  <DocumentName>sample string 2</DocumentName>
  <ERegistryBatchId>1</ERegistryBatchId>
  <ERegistryRequestStatusTypeId>1</ERegistryRequestStatusTypeId>
  <ERegistryTransactionRequestTypeId>1</ERegistryTransactionRequestTypeId>
  <EndDate>2024-11-26T17:13:32.1952435-05:00</EndDate>
  <MIN>sample string 3</MIN>
  <StartDate>2024-11-26T17:13:32.1952435-05:00</StartDate>
  <TrackingNumber>sample string 1</TrackingNumber>
</EDeliveryRequestSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The CSV file of eDelivery requests.

ESignSystems.SmartSAFE.Models.Shared.FileDownloadModel

Name	Description	Type	Additional information
File	Gets or sets the file to be downloaded.	Collection of byte	None.
FileName	Gets or sets the name of the file to be downloaded.	string	None.
MimeType	Gets or sets the mime type of the file to be downloaded.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "File": "QEA=",
  "FileName": "sample string 1",
  "MimeType": "sample string 2"
}

application/xml, text/xml

Sample:

<FileDownloadModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Shared">
  <File>QEA=</File>
  <FileName>sample string 1</FileName>
  <MimeType>sample string 2</MimeType>
</FileDownloadModel>