POST api/Lead/GetLeadsIds

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LeadName	string	None.
Zip	string	None.
AssociateId	integer	None.
LeadFilterPool	LeadFilterTypeEnum	None.
LeadFilterType	LeadOriginTypeFilterEnum	None.
CallStatus	CallStatusTypeEnum	None.
Proximity	ProximityEnum	None.
SourceLattitude	decimal number	None.
SourceLongitude	decimal number	None.
PageIndex	integer	None.
PageSize	integer	None.
SortBy	string	None.
SortOrder	string	None.
SortColumnIndex	integer	None.
LeadBankType	LeadBankTypeEnum	None.
LeadFilterGroupType	LeadFilterGroupTypeEnum	None.
PhoneNo	string	None.
StarredColorId	integer	None.
StarredColorFilter	Collection of integer	None.
PhoneNoContains	string	None.
GroupId	integer	None.
Age	integer	None.
AgeOption	integer	None.
StateId	integer	None.
IsBackgroundCall	boolean	None.
IncludeAdditionalPhones	boolean	None.
isFavoriteOnly	boolean	None.
TraineeAssociateId	integer	None.
PreferredAppointmentTime	string	None.
TimezoneId	integer	None.
TimezoneSortBy	string	None.
PreferredLanguageType	string	None.
ShowUndialedOnly	boolean	None.
GroupMarketPlaceId	integer	None.
LeadInboxFilterExpireRule	LeadInboxFilterExpireRuleEnum	None.
LeadTagsFilter	Collection of integer	None.
LocationContextCodes	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "LeadName": "sample string 1",
  "Zip": "sample string 2",
  "AssociateId": 1,
  "LeadFilterPool": 1,
  "LeadFilterType": 1,
  "CallStatus": 1,
  "Proximity": 1,
  "SourceLattitude": 1.1,
  "SourceLongitude": 1.1,
  "PageIndex": 1,
  "PageSize": 1,
  "SortBy": "sample string 3",
  "SortOrder": "sample string 4",
  "SortColumnIndex": 1,
  "LeadBankType": 1,
  "LeadFilterGroupType": 0,
  "PhoneNo": "sample string 5",
  "StarredColorId": 6,
  "StarredColorFilter": [
    1,
    2
  ],
  "PhoneNoContains": "sample string 7",
  "GroupId": 1,
  "Age": 8,
  "AgeOption": 1,
  "StateId": 1,
  "IsBackgroundCall": true,
  "IncludeAdditionalPhones": true,
  "isFavoriteOnly": true,
  "TraineeAssociateId": 1,
  "PreferredAppointmentTime": "sample string 12",
  "TimezoneId": 1,
  "TimezoneSortBy": "sample string 13",
  "PreferredLanguageType": "sample string 14",
  "ShowUndialedOnly": true,
  "GroupMarketPlaceId": 16,
  "LeadInboxFilterExpireRule": 1,
  "LeadTagsFilter": [
    1,
    2
  ],
  "LocationContextCodes": [
    "sample string 1",
    "sample string 2"
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PagedDTOOfInt64

Name	Type	Additional information
PagedRecords	Collection of integer	None.
Data	Collection of integer	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": [
    1,
    2
  ],
  "Data": [
    1,
    2
  ],
  "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"
}