POST api/AdminTextMessage/LoadActiveMessages

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
MessageStatus	integer	None.
MessageTypeSearchString	string	None.
FromDate	date	None.
EndDate	date	None.
SortColumn	string	None.
SortDirection	string	None.
PageIndex	integer	None.
PageSize	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "MessageStatus": 1,
  "MessageTypeSearchString": "sample string 2",
  "FromDate": "2026-02-03T18:24:09.9872037-08:00",
  "EndDate": "2026-02-03T18:24:09.9872037-08:00",
  "SortColumn": "sample string 3",
  "SortDirection": "sample string 4",
  "PageIndex": 5,
  "PageSize": 6
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PagedDTOOfAdminTextDashboardDTO

Name	Type	Additional information
PagedRecords	Collection of AdminTextDashboardDTO	None.
Data	Collection of AdminTextDashboardDTO	None.
TotalRecords	integer	None.
TotalAssociateRecords	integer	None.
CwaTotal	decimal number	None.
AlpTotal	decimal number	None.
AnHTotal	decimal number	None.
SubmittedAgentCount	integer	None.
TotalNoPrds	integer	None.
TotalCompletedNoPrds	decimal number	None.
TotalCancelNoPrds	integer	None.
TotalAlpNoPrds	decimal number	None.
FormattedTotalAlpNoPrds	string	None.
TotalCompletedAlpNoPrds	decimal number	None.
FormattedTotalCompletedAlpNoPrds	string	None.
TotalCancelAlpNoPrds	decimal number	None.
FormattedTotalCancelAlpNoPrds	string	None.
IsSearchLimitCompleted	boolean	None.
PolicySearchesLeft	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PagedRecords": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "TotalRecipentCount": 1,
      "AdminTextMessageId": 1,
      "MessageStatus": 1,
      "ReviewStatus": 1,
      "MessageContent": "sample string 3",
      "USRegionPhoneNumber": "sample string 4",
      "CAPhoneNumber": "sample string 5",
      "FriendlyName": "sample string 6",
      "CompletedDateTime": "2026-02-03T18:24:09.9872037-08:00",
      "AdminTextScheduledMessageId": 1,
      "CreatedBy": 1,
      "CreatedByName": "sample string 7",
      "CompletedDateTimeString": "2/03/2026 06:24:09 PM",
      "CompletedDateTimePST": "2026-02-03T18:24:09.9872037-08:00",
      "CompletedDateTimeStringPST": "2/03/2026 06:24:09 PM"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "TotalRecipentCount": 1,
      "AdminTextMessageId": 1,
      "MessageStatus": 1,
      "ReviewStatus": 1,
      "MessageContent": "sample string 3",
      "USRegionPhoneNumber": "sample string 4",
      "CAPhoneNumber": "sample string 5",
      "FriendlyName": "sample string 6",
      "CompletedDateTime": "2026-02-03T18:24:09.9872037-08:00",
      "AdminTextScheduledMessageId": 1,
      "CreatedBy": 1,
      "CreatedByName": "sample string 7",
      "CompletedDateTimeString": "2/03/2026 06:24:09 PM",
      "CompletedDateTimePST": "2026-02-03T18:24:09.9872037-08:00",
      "CompletedDateTimeStringPST": "2/03/2026 06:24:09 PM"
    }
  ],
  "Data": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "TotalRecipentCount": 1,
      "AdminTextMessageId": 1,
      "MessageStatus": 1,
      "ReviewStatus": 1,
      "MessageContent": "sample string 3",
      "USRegionPhoneNumber": "sample string 4",
      "CAPhoneNumber": "sample string 5",
      "FriendlyName": "sample string 6",
      "CompletedDateTime": "2026-02-03T18:24:09.9872037-08:00",
      "AdminTextScheduledMessageId": 1,
      "CreatedBy": 1,
      "CreatedByName": "sample string 7",
      "CompletedDateTimeString": "2/03/2026 06:24:09 PM",
      "CompletedDateTimePST": "2026-02-03T18:24:09.9872037-08:00",
      "CompletedDateTimeStringPST": "2/03/2026 06:24:09 PM"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "TotalRecipentCount": 1,
      "AdminTextMessageId": 1,
      "MessageStatus": 1,
      "ReviewStatus": 1,
      "MessageContent": "sample string 3",
      "USRegionPhoneNumber": "sample string 4",
      "CAPhoneNumber": "sample string 5",
      "FriendlyName": "sample string 6",
      "CompletedDateTime": "2026-02-03T18:24:09.9872037-08:00",
      "AdminTextScheduledMessageId": 1,
      "CreatedBy": 1,
      "CreatedByName": "sample string 7",
      "CompletedDateTimeString": "2/03/2026 06:24:09 PM",
      "CompletedDateTimePST": "2026-02-03T18:24:09.9872037-08:00",
      "CompletedDateTimeStringPST": "2/03/2026 06:24:09 PM"
    }
  ],
  "TotalRecords": 1,
  "TotalAssociateRecords": 2,
  "CwaTotal": 3.1,
  "AlpTotal": 4.1,
  "AnHTotal": 5.1,
  "SubmittedAgentCount": 6,
  "TotalNoPrds": 7,
  "TotalCompletedNoPrds": 8.1,
  "TotalCancelNoPrds": 9,
  "TotalAlpNoPrds": 10.1,
  "FormattedTotalAlpNoPrds": "10.10",
  "TotalCompletedAlpNoPrds": 11.1,
  "FormattedTotalCompletedAlpNoPrds": "11.10",
  "TotalCancelAlpNoPrds": 12.1,
  "FormattedTotalCancelAlpNoPrds": "12.10",
  "IsSearchLimitCompleted": true,
  "PolicySearchesLeft": "sample string 14"
}