POST api/Lead/GetLeadsForOrderFulfillmentV2

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
IsCurrentArea	boolean	None.
CurrentAreaRank	integer	None.
UseDefaultZip	boolean	None.
CityIds	Collection of integer	None.
StateIds	Collection of integer	None.
States	Collection of string	None.
Cities	Collection of string	None.
CitiesAndStates	Collection of string	None.
ZipCodes	Collection of string	None.
GroupCode	string	None.
isLOHOnly	boolean	None.
isAvailableOnly	boolean	None.
LeadOrigins	Collection of integer	None.
Languages	Collection of integer	None.
LeadBanks	Collection of integer	None.
LeadResolutionTypes	Collection of integer	None.
SelectedAssociateId	integer	None.
AssociateContractId	integer	None.
pageindex	integer	None.
pagesize	integer	None.
sortby	string	None.
sortorder	string	None.
IsJqModel	boolean	None.
FromDate	date	None.
ToDate	date	None.
AltId	Collection of integer	None.
isAltID	boolean	None.
LeadIds	Collection of integer	None.
isLeadId	boolean	None.
LastName	string	None.
AltIdNum	integer	None.
isUnResolvedLeads	boolean	None.
LeadId	integer	None.
isImportGrp	boolean	None.
c1Add	string	None.
c2Add	string	None.
grpCode	string	None.
recordCount	integer	None.
leadOriginId	integer	None.
cityId	integer	None.
dgCoverage	string	None.
ShowDefaultSummary	boolean	None.
ShowTotalForLeadSummary	boolean	None.
macOfficeAssociateHierarchies	Collection of AssociateHierarchyDTO	None.
OfficeName	string	None.
FilterMappings	Collection of Pair of string [key] and Pair of string [key] and OperatorsEnum [value] [value]	None.
LposGroupId	integer	None.
LeadStatuses	Collection of integer	None.
ApplicationFeatureId	integer	None.
PrimaryPhone	string	None.
SGAPartner	Collection of string	None.
InstantLeadAssociateId	string	None.
ResolvedPOSType	Collection of integer	None.
LeadMktPlace	Collection of integer	None.
ShowExpiredOutLeads	boolean	None.
LeadTagIds	Collection of integer	None.
HideInternalTags	boolean	None.
Loc	string	None.

Request Formats

application/json, text/json

Sample:

{
  "IsCurrentArea": true,
  "CurrentAreaRank": 2,
  "UseDefaultZip": true,
  "CityIds": [
    1,
    2
  ],
  "StateIds": [
    1,
    2
  ],
  "States": [
    "sample string 1",
    "sample string 2"
  ],
  "Cities": [
    "sample string 1",
    "sample string 2"
  ],
  "CitiesAndStates": [
    "sample string 1",
    "sample string 2"
  ],
  "ZipCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "GroupCode": "sample string 4",
  "isLOHOnly": true,
  "isAvailableOnly": true,
  "LeadOrigins": [
    1,
    2
  ],
  "Languages": [
    1,
    1
  ],
  "LeadBanks": [
    1,
    2
  ],
  "LeadResolutionTypes": [
    1,
    2
  ],
  "SelectedAssociateId": 7,
  "AssociateContractId": 1,
  "pageindex": 8,
  "pagesize": 9,
  "sortby": "sample string 10",
  "sortorder": "sample string 11",
  "IsJqModel": true,
  "FromDate": "2026-02-03T18:29:57.956304-08:00",
  "ToDate": "2026-02-03T18:29:57.956304-08:00",
  "AltId": [
    1,
    2
  ],
  "isAltID": true,
  "LeadIds": [
    1,
    2
  ],
  "isLeadId": true,
  "LastName": "sample string 17",
  "AltIdNum": 1,
  "isUnResolvedLeads": true,
  "LeadId": 1,
  "isImportGrp": true,
  "c1Add": "sample string 20",
  "c2Add": "sample string 21",
  "grpCode": "sample string 22",
  "recordCount": 1,
  "leadOriginId": 1,
  "cityId": 1,
  "dgCoverage": "sample string 23",
  "ShowDefaultSummary": true,
  "ShowTotalForLeadSummary": true,
  "macOfficeAssociateHierarchies": [
    {
      "UserId": 1,
      "AssociateId": 2,
      "AssociateContractId": 3,
      "ReportToContractId": 1,
      "ReportToAssociateId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "BusinessAssociateCode": "sample string 6",
      "ContractCode": "sample string 7",
      "RoleId": 8,
      "RoleName": "sample string 9",
      "RoleShortName": "sample string 10",
      "Email": "sample string 11",
      "EmailVerificationStatus": 1,
      "Level": 12,
      "UserStatus": 0,
      "HierarchyId": 13,
      "RoleTypeId": 14,
      "Phone": "sample string 15",
      "Mobile": "sample string 16",
      "OfficeId": 17,
      "OfficeName": "sample string 18",
      "ContractStartDate": "2026-02-03T18:29:57.956304-08:00",
      "HireDate": "2026-02-03T18:29:57.956304-08:00",
      "TerminationDate": "2026-02-03T18:29:57.956304-08:00",
      "IsContractTerminated": true,
      "FullName": "sample string 5, sample string 4",
      "DescriptiveName": "sample string 5, sample string 4 - sample string 9 (sample string 6) ",
      "DescriptiveNameWithoutRole": "(sample string 6) sample string 5, sample string 4",
      "FullNameWithHierarchyInfo": "sample string 5, sample string 4 - sample string 10(sample string 6) ",
      "FullNameWithShortRoleName": "sample string 5, sample string 4 - sample string 10(sample string 6) ",
      "FullRoleDescription": "sample string 10sample string 6",
      "FullNameWithBusinessCode": "sample string 5, sample string 4 - sample string 6",
      "ManagerFullName": "sample string 21, sample string 20 - sample string 10 (sample string 22)",
      "ManagerDescriptiveName": "sample string 21, sample string 20 - sample string 9 (sample string 6) ",
      "DisplayNameExcludeingPipelineInfo": "sample string 5, sample string 4 - sample string 9 (sample string 6 -- 1%)",
      "ManagerFirstName": "sample string 20",
      "ManagerLastName": "sample string 21",
      "ManagerBusinessAssociateCode": "sample string 22",
      "CreateDate": "2026-02-03T18:29:57.956304-08:00",
      "ManagerId": 24,
      "IsSelected": true,
      "ManagerOfficeId": 26,
      "IsCoperate": true,
      "IsRGAExtended": true,
      "IsSimilarManagerAlreadyMerged": true,
      "AssociatePipelineStatus": 1,
      "LicensedDate": "2026-02-03T18:29:57.956304-08:00",
      "AgencyNotes": "sample string 31",
      "AgencyNotesID": 32,
      "LastLogin": "2026-02-03T18:29:57.956304-08:00",
      "PerCompleted": 1,
      "TestDate": "2026-02-03T18:29:57.956304-08:00",
      "ExamFxId": 33,
      "OliversDataId": 34,
      "XcelLicenseingSchoolId": 35,
      "BestScore": 1,
      "ScoreDetails": [
        "sample string 1",
        "sample string 2"
      ],
      "isAgencyDisplayFakeRoleName": true,
      "IsManagerHierarchyTerminateUser": true,
      "SaName": "sample string 38",
      "GaName": "sample string 39",
      "MgaName": "sample string 40",
      "RGAName": "sample string 41",
      "ContractTypeId": 1,
      "ContractType": "",
      "IsNoMatterWhat": true,
      "RGAHierarchyLevel": "sample string 43",
      "ContractPercentage": 1.0,
      "GroupMarketPlaceId": 1,
      "LocationCode": "sample string 44",
      "LocationContextCode": "sample string 45"
    },
    {
      "UserId": 1,
      "AssociateId": 2,
      "AssociateContractId": 3,
      "ReportToContractId": 1,
      "ReportToAssociateId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "BusinessAssociateCode": "sample string 6",
      "ContractCode": "sample string 7",
      "RoleId": 8,
      "RoleName": "sample string 9",
      "RoleShortName": "sample string 10",
      "Email": "sample string 11",
      "EmailVerificationStatus": 1,
      "Level": 12,
      "UserStatus": 0,
      "HierarchyId": 13,
      "RoleTypeId": 14,
      "Phone": "sample string 15",
      "Mobile": "sample string 16",
      "OfficeId": 17,
      "OfficeName": "sample string 18",
      "ContractStartDate": "2026-02-03T18:29:57.956304-08:00",
      "HireDate": "2026-02-03T18:29:57.956304-08:00",
      "TerminationDate": "2026-02-03T18:29:57.956304-08:00",
      "IsContractTerminated": true,
      "FullName": "sample string 5, sample string 4",
      "DescriptiveName": "sample string 5, sample string 4 - sample string 9 (sample string 6) ",
      "DescriptiveNameWithoutRole": "(sample string 6) sample string 5, sample string 4",
      "FullNameWithHierarchyInfo": "sample string 5, sample string 4 - sample string 10(sample string 6) ",
      "FullNameWithShortRoleName": "sample string 5, sample string 4 - sample string 10(sample string 6) ",
      "FullRoleDescription": "sample string 10sample string 6",
      "FullNameWithBusinessCode": "sample string 5, sample string 4 - sample string 6",
      "ManagerFullName": "sample string 21, sample string 20 - sample string 10 (sample string 22)",
      "ManagerDescriptiveName": "sample string 21, sample string 20 - sample string 9 (sample string 6) ",
      "DisplayNameExcludeingPipelineInfo": "sample string 5, sample string 4 - sample string 9 (sample string 6 -- 1%)",
      "ManagerFirstName": "sample string 20",
      "ManagerLastName": "sample string 21",
      "ManagerBusinessAssociateCode": "sample string 22",
      "CreateDate": "2026-02-03T18:29:57.956304-08:00",
      "ManagerId": 24,
      "IsSelected": true,
      "ManagerOfficeId": 26,
      "IsCoperate": true,
      "IsRGAExtended": true,
      "IsSimilarManagerAlreadyMerged": true,
      "AssociatePipelineStatus": 1,
      "LicensedDate": "2026-02-03T18:29:57.956304-08:00",
      "AgencyNotes": "sample string 31",
      "AgencyNotesID": 32,
      "LastLogin": "2026-02-03T18:29:57.956304-08:00",
      "PerCompleted": 1,
      "TestDate": "2026-02-03T18:29:57.956304-08:00",
      "ExamFxId": 33,
      "OliversDataId": 34,
      "XcelLicenseingSchoolId": 35,
      "BestScore": 1,
      "ScoreDetails": [
        "sample string 1",
        "sample string 2"
      ],
      "isAgencyDisplayFakeRoleName": true,
      "IsManagerHierarchyTerminateUser": true,
      "SaName": "sample string 38",
      "GaName": "sample string 39",
      "MgaName": "sample string 40",
      "RGAName": "sample string 41",
      "ContractTypeId": 1,
      "ContractType": "",
      "IsNoMatterWhat": true,
      "RGAHierarchyLevel": "sample string 43",
      "ContractPercentage": 1.0,
      "GroupMarketPlaceId": 1,
      "LocationCode": "sample string 44",
      "LocationContextCode": "sample string 45"
    }
  ],
  "OfficeName": "sample string 26",
  "FilterMappings": [
    {
      "Key": "sample string 1",
      "Value": {
        "Key": "sample string 1",
        "Value": 0
      }
    },
    {
      "Key": "sample string 1",
      "Value": {
        "Key": "sample string 1",
        "Value": 0
      }
    }
  ],
  "LposGroupId": 1,
  "LeadStatuses": [
    1,
    2
  ],
  "ApplicationFeatureId": 27,
  "PrimaryPhone": "sample string 28",
  "SGAPartner": [
    "sample string 1",
    "sample string 2"
  ],
  "InstantLeadAssociateId": "sample string 29",
  "ResolvedPOSType": [
    1,
    2
  ],
  "LeadMktPlace": [
    1,
    2
  ],
  "ShowExpiredOutLeads": true,
  "LeadTagIds": [
    1,
    1
  ],
  "HideInternalTags": true,
  "Loc": "sample string 31"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LeadsAndLeadsSummaryDTO

Name	Description	Type	Additional information
leads		PagedDTOOfLeadDTO	None.
summary		AssignmentSummaryDTO	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.