POST api/Report/GetRetentionData

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PageIndex	integer	None.
PageSize	integer	None.
SortBy	string	None.
SortOrder	string	None.
SortColumnIndex	integer	None.
AssociateId	integer	None.
Role	string	None.
LocationContextCode	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PageIndex": 1,
  "PageSize": 1,
  "SortBy": "sample string 1",
  "SortOrder": "sample string 2",
  "SortColumnIndex": 1,
  "AssociateId": 3,
  "Role": "sample string 4",
  "LocationContextCode": "sample string 5"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PagedDTOOfRetentionReportDTO

Name	Type	Additional information
PagedRecords	Collection of RetentionReportDTO	None.
Data	Collection of RetentionReportDTO	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": [
    {
      "PolicyNumber": "sample string 1",
      "Office": "sample string 2",
      "AgentName": "sample string 3",
      "AppDate": "2026-02-03T18:25:48.0138806-08:00",
      "IssueDate": "2026-02-03T18:25:48.0138806-08:00",
      "PaidToDate": "2026-02-03T18:25:48.0138806-08:00",
      "MonthIn": "sample string 4",
      "Stage": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "Address": "sample string 8",
      "City": "sample string 9",
      "State": "sample string 10",
      "Zip": "sample string 11",
      "Phone": "sample string 12",
      "SecondaryPhone": "sample string 13",
      "SpecialBilling": 1.0,
      "AnnualBilling": 1.0,
      "Plan": "sample string 14",
      "Type": "sample string 15",
      "DueDay": "sample string 16",
      "Comments": "sample string 17",
      "Saname": "sample string 18",
      "Ganame": "sample string 19",
      "Mganame": "sample string 20",
      "Rganame": "sample string 21",
      "ToDo": "sample string 22",
      "AssociateId": 23,
      "Location": "sample string 24",
      "PolicyId": 1,
      "AppointmentDateString": "2/3/2026",
      "IssueDateString": "2/3/2026",
      "PaidToDateString": "2/3/2026",
      "SpecialBillingString": "$1",
      "AnnualBillingString": "$1",
      "IsTerminated": true
    },
    {
      "PolicyNumber": "sample string 1",
      "Office": "sample string 2",
      "AgentName": "sample string 3",
      "AppDate": "2026-02-03T18:25:48.0138806-08:00",
      "IssueDate": "2026-02-03T18:25:48.0138806-08:00",
      "PaidToDate": "2026-02-03T18:25:48.0138806-08:00",
      "MonthIn": "sample string 4",
      "Stage": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "Address": "sample string 8",
      "City": "sample string 9",
      "State": "sample string 10",
      "Zip": "sample string 11",
      "Phone": "sample string 12",
      "SecondaryPhone": "sample string 13",
      "SpecialBilling": 1.0,
      "AnnualBilling": 1.0,
      "Plan": "sample string 14",
      "Type": "sample string 15",
      "DueDay": "sample string 16",
      "Comments": "sample string 17",
      "Saname": "sample string 18",
      "Ganame": "sample string 19",
      "Mganame": "sample string 20",
      "Rganame": "sample string 21",
      "ToDo": "sample string 22",
      "AssociateId": 23,
      "Location": "sample string 24",
      "PolicyId": 1,
      "AppointmentDateString": "2/3/2026",
      "IssueDateString": "2/3/2026",
      "PaidToDateString": "2/3/2026",
      "SpecialBillingString": "$1",
      "AnnualBillingString": "$1",
      "IsTerminated": true
    }
  ],
  "Data": [
    {
      "PolicyNumber": "sample string 1",
      "Office": "sample string 2",
      "AgentName": "sample string 3",
      "AppDate": "2026-02-03T18:25:48.0138806-08:00",
      "IssueDate": "2026-02-03T18:25:48.0138806-08:00",
      "PaidToDate": "2026-02-03T18:25:48.0138806-08:00",
      "MonthIn": "sample string 4",
      "Stage": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "Address": "sample string 8",
      "City": "sample string 9",
      "State": "sample string 10",
      "Zip": "sample string 11",
      "Phone": "sample string 12",
      "SecondaryPhone": "sample string 13",
      "SpecialBilling": 1.0,
      "AnnualBilling": 1.0,
      "Plan": "sample string 14",
      "Type": "sample string 15",
      "DueDay": "sample string 16",
      "Comments": "sample string 17",
      "Saname": "sample string 18",
      "Ganame": "sample string 19",
      "Mganame": "sample string 20",
      "Rganame": "sample string 21",
      "ToDo": "sample string 22",
      "AssociateId": 23,
      "Location": "sample string 24",
      "PolicyId": 1,
      "AppointmentDateString": "2/3/2026",
      "IssueDateString": "2/3/2026",
      "PaidToDateString": "2/3/2026",
      "SpecialBillingString": "$1",
      "AnnualBillingString": "$1",
      "IsTerminated": true
    },
    {
      "PolicyNumber": "sample string 1",
      "Office": "sample string 2",
      "AgentName": "sample string 3",
      "AppDate": "2026-02-03T18:25:48.0138806-08:00",
      "IssueDate": "2026-02-03T18:25:48.0138806-08:00",
      "PaidToDate": "2026-02-03T18:25:48.0138806-08:00",
      "MonthIn": "sample string 4",
      "Stage": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "Address": "sample string 8",
      "City": "sample string 9",
      "State": "sample string 10",
      "Zip": "sample string 11",
      "Phone": "sample string 12",
      "SecondaryPhone": "sample string 13",
      "SpecialBilling": 1.0,
      "AnnualBilling": 1.0,
      "Plan": "sample string 14",
      "Type": "sample string 15",
      "DueDay": "sample string 16",
      "Comments": "sample string 17",
      "Saname": "sample string 18",
      "Ganame": "sample string 19",
      "Mganame": "sample string 20",
      "Rganame": "sample string 21",
      "ToDo": "sample string 22",
      "AssociateId": 23,
      "Location": "sample string 24",
      "PolicyId": 1,
      "AppointmentDateString": "2/3/2026",
      "IssueDateString": "2/3/2026",
      "PaidToDateString": "2/3/2026",
      "SpecialBillingString": "$1",
      "AnnualBillingString": "$1",
      "IsTerminated": true
    }
  ],
  "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"
}