POST api/OptOutAndDNC/GetAllOptOutAndDNCUsers
Request Information
URI Parameters
None.
Body Parameters
SearchOptOutDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| PageIndex | integer |
None. |
|
| Pagesize | integer |
None. |
|
| SortBy | string |
None. |
|
| SortOrder | string |
None. |
|
| SearchOptOutUser | string |
None. |
|
| SearchBy | string |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| SearchCategoryType | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"PageIndex": 1,
"Pagesize": 2,
"SortBy": "sample string 3",
"SortOrder": "sample string 4",
"SearchOptOutUser": "sample string 5",
"SearchBy": "sample string 6",
"StartDate": "2026-02-03T18:28:29.8476053-08:00",
"EndDate": "2026-02-03T18:28:29.8476053-08:00",
"SearchCategoryType": "sample string 9"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PagedDTOOfOptOutAndDncDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| PagedRecords | Collection of OptOutAndDncDTO |
None. |
|
| Data | Collection of OptOutAndDncDTO |
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,
"LeadId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Phone": "sample string 4",
"Email": "sample string 5",
"DateTimeOptOut": "2026-02-03T18:28:29.8476053-08:00",
"IsMarkedDNC": true,
"CreatedBy": 1,
"ChangedBy": 1,
"CreateDate": "2026-02-03T18:28:29.8476053-08:00",
"ChangedDate": "2026-02-03T18:28:29.8476053-08:00",
"OptOutType": "sample string 7",
"Disabled": true,
"IsDuplicate": true,
"ApplicationFeatureId": 9,
"LastMessageSentDate": "2026-02-03T18:28:29.8476053-08:00",
"LastCampaignId": 1,
"LastCampaignSent": "sample string 10",
"LeadGroupCodeName": "sample string 11",
"LeadMarket": "sample string 12",
"Address": "sample string 13",
"City": "sample string 14",
"State": "sample string 15",
"Zip": "sample string 16",
"Country": "sample string 17",
"PhoneOptedOutFrom": "sample string 18",
"LeadImportDate": "2026-02-03T18:28:29.8476053-08:00",
"AddedBackOn": "2026-02-03T18:28:29.8476053-08:00",
"AddedBackBy": 1,
"AddedBackByString": "sample string 19",
"LastMessageSentDateString": "2/03/2026 06:28:29 PM",
"LeadIdToString": "1",
"LeadImportDateString": "2/03/2026 06:28:29 PM",
"DateTimeOptOutString": "2/03/2026 06:28:29 PM",
"AddedBackOnString": "2/03/2026 06:28:29 PM"
},
{
"Id": 1,
"LeadId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Phone": "sample string 4",
"Email": "sample string 5",
"DateTimeOptOut": "2026-02-03T18:28:29.8476053-08:00",
"IsMarkedDNC": true,
"CreatedBy": 1,
"ChangedBy": 1,
"CreateDate": "2026-02-03T18:28:29.8476053-08:00",
"ChangedDate": "2026-02-03T18:28:29.8476053-08:00",
"OptOutType": "sample string 7",
"Disabled": true,
"IsDuplicate": true,
"ApplicationFeatureId": 9,
"LastMessageSentDate": "2026-02-03T18:28:29.8476053-08:00",
"LastCampaignId": 1,
"LastCampaignSent": "sample string 10",
"LeadGroupCodeName": "sample string 11",
"LeadMarket": "sample string 12",
"Address": "sample string 13",
"City": "sample string 14",
"State": "sample string 15",
"Zip": "sample string 16",
"Country": "sample string 17",
"PhoneOptedOutFrom": "sample string 18",
"LeadImportDate": "2026-02-03T18:28:29.8476053-08:00",
"AddedBackOn": "2026-02-03T18:28:29.8476053-08:00",
"AddedBackBy": 1,
"AddedBackByString": "sample string 19",
"LastMessageSentDateString": "2/03/2026 06:28:29 PM",
"LeadIdToString": "1",
"LeadImportDateString": "2/03/2026 06:28:29 PM",
"DateTimeOptOutString": "2/03/2026 06:28:29 PM",
"AddedBackOnString": "2/03/2026 06:28:29 PM"
}
],
"Data": [
{
"Id": 1,
"LeadId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Phone": "sample string 4",
"Email": "sample string 5",
"DateTimeOptOut": "2026-02-03T18:28:29.8476053-08:00",
"IsMarkedDNC": true,
"CreatedBy": 1,
"ChangedBy": 1,
"CreateDate": "2026-02-03T18:28:29.8476053-08:00",
"ChangedDate": "2026-02-03T18:28:29.8476053-08:00",
"OptOutType": "sample string 7",
"Disabled": true,
"IsDuplicate": true,
"ApplicationFeatureId": 9,
"LastMessageSentDate": "2026-02-03T18:28:29.8476053-08:00",
"LastCampaignId": 1,
"LastCampaignSent": "sample string 10",
"LeadGroupCodeName": "sample string 11",
"LeadMarket": "sample string 12",
"Address": "sample string 13",
"City": "sample string 14",
"State": "sample string 15",
"Zip": "sample string 16",
"Country": "sample string 17",
"PhoneOptedOutFrom": "sample string 18",
"LeadImportDate": "2026-02-03T18:28:29.8476053-08:00",
"AddedBackOn": "2026-02-03T18:28:29.8476053-08:00",
"AddedBackBy": 1,
"AddedBackByString": "sample string 19",
"LastMessageSentDateString": "2/03/2026 06:28:29 PM",
"LeadIdToString": "1",
"LeadImportDateString": "2/03/2026 06:28:29 PM",
"DateTimeOptOutString": "2/03/2026 06:28:29 PM",
"AddedBackOnString": "2/03/2026 06:28:29 PM"
},
{
"Id": 1,
"LeadId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Phone": "sample string 4",
"Email": "sample string 5",
"DateTimeOptOut": "2026-02-03T18:28:29.8476053-08:00",
"IsMarkedDNC": true,
"CreatedBy": 1,
"ChangedBy": 1,
"CreateDate": "2026-02-03T18:28:29.8476053-08:00",
"ChangedDate": "2026-02-03T18:28:29.8476053-08:00",
"OptOutType": "sample string 7",
"Disabled": true,
"IsDuplicate": true,
"ApplicationFeatureId": 9,
"LastMessageSentDate": "2026-02-03T18:28:29.8476053-08:00",
"LastCampaignId": 1,
"LastCampaignSent": "sample string 10",
"LeadGroupCodeName": "sample string 11",
"LeadMarket": "sample string 12",
"Address": "sample string 13",
"City": "sample string 14",
"State": "sample string 15",
"Zip": "sample string 16",
"Country": "sample string 17",
"PhoneOptedOutFrom": "sample string 18",
"LeadImportDate": "2026-02-03T18:28:29.8476053-08:00",
"AddedBackOn": "2026-02-03T18:28:29.8476053-08:00",
"AddedBackBy": 1,
"AddedBackByString": "sample string 19",
"LastMessageSentDateString": "2/03/2026 06:28:29 PM",
"LeadIdToString": "1",
"LeadImportDateString": "2/03/2026 06:28:29 PM",
"DateTimeOptOutString": "2/03/2026 06:28:29 PM",
"AddedBackOnString": "2/03/2026 06:28:29 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"
}