GET api/HLMonitor/GetMessageData/{startDate}/{endDate}?docType={docType}

Retrieves the message data for a given date range and document type.

Alternative Calls:

  • GET api/HLMonitor/GetMessageData?startDate={startDate}&endDate={endDate}
  • GET api/HLMonitor/GetMessageData?startDate={startDate}&endDate={endDate}&docType={docType}
  • GET api/HLMonitor/GetMessageData/{startDate}/{endDate}
  • GET api/HLMonitor/GetMessageData/{startDate}/{endDate}/{docType}
  • GET api/HLMonitor/GetMessageData/{docType}?startDate={startDate}&endDate={endDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDate

The start date of the task data to retrieve.

 date

Required
endDate

The end date of the task data to retrieve.

 date

Required
docType

Document type filter.

 string

Optional

Body Parameters

None.

Response Information

Resource Description

A JSON string containing the message data for the specified date range.

string

Response Formats

application/json, text/json

Sample: 

[
    {
      "Id": 1234,
      "Subject": "Sample Subject",
      "Body": "Sample Message Body",
      "HtmlBody": "<HTML> </HTML>",
      "SentDate": "2023-01-19T08:36:20.07",
      "ReceivedDate": "2023-01-19T08:36:20.07",
      "SenderName": "Adam Smith",
      "SenderEmailAddress": "Adam.Smith@example.com",
      "MarkedAsTax": false,
      "Status": "Message Status",
      "TaskName": "Sample Capital Statement"
    }
]

application/xml, text/xml

Sample: 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>