POST ClaimEligibility/GetClaimsEligibilitySearch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
searchFamilyId	string	None.
searchName	string	None.
searchSSNPrimary	string	None.
searchSSNPatient	string	None.
searchBirthDate	date	None.
searchAsOfDate	date	None.
page	integer	None.
pageSize	integer	None.
oldSortProperty	string	None.
newSortProperty	string	None.
sortDir	string	None.
sortOrder	SortDirection	None.
claimTypeFilter	string	None.
patientNameFilter	string	None.
LoginType	integer	None.
LoginKey	integer	None.
encryptedValues	string	None.
dateRange	DateRange	None.

Request Formats

application/json, text/json

Sample:

{
  "dateRange": {
    "FromDate": "2025-11-03T00:03:56.8511599-06:00",
    "ToDate": "2025-11-03T00:03:56.8511599-06:00"
  },
  "searchFamilyId": "sample string 1",
  "searchName": "sample string 2",
  "searchSSNPrimary": "sample string 3",
  "searchSSNPatient": "sample string 4",
  "searchBirthDate": "2025-11-03T00:03:56.8511599-06:00",
  "searchAsOfDate": "2025-11-03T00:03:56.8511599-06:00",
  "page": 5,
  "pageSize": 6,
  "oldSortProperty": "sample string 7",
  "newSortProperty": "sample string 8",
  "sortDir": "sample string 9",
  "sortOrder": 0,
  "claimTypeFilter": "sample string 10",
  "patientNameFilter": "sample string 11",
  "LoginType": 12,
  "LoginKey": 13,
  "encryptedValues": "sample string 14"
}

application/xml, text/xml

Sample:

<ClaimEligibilitySearchViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models">
  <LoginKey>13</LoginKey>
  <LoginType>12</LoginType>
  <claimTypeFilter>sample string 10</claimTypeFilter>
  <dateRange>
    <FromDate>2025-11-03T00:03:56.8511599-06:00</FromDate>
    <ToDate>2025-11-03T00:03:56.8511599-06:00</ToDate>
  </dateRange>
  <encryptedValues>sample string 14</encryptedValues>
  <newSortProperty>sample string 8</newSortProperty>
  <oldSortProperty>sample string 7</oldSortProperty>
  <page>5</page>
  <pageSize>6</pageSize>
  <patientNameFilter>sample string 11</patientNameFilter>
  <searchAsOfDate>2025-11-03T00:03:56.8511599-06:00</searchAsOfDate>
  <searchBirthDate>2025-11-03T00:03:56.8511599-06:00</searchBirthDate>
  <searchFamilyId>sample string 1</searchFamilyId>
  <searchName>sample string 2</searchName>
  <searchSSNPatient>sample string 4</searchSSNPatient>
  <searchSSNPrimary>sample string 3</searchSSNPrimary>
  <sortDir>sample string 9</sortDir>
  <sortOrder>Ascending</sortOrder>
</ClaimEligibilitySearchViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ClaimEligibilityDetail

Name	Type	Additional information
MBEligibilityKey	integer	None.
PBEntityKey	integer	None.
MBMemberKey	integer	None.
PLPlanKey	integer	None.
PLPlanDesc	string	None.
PLCovTypeHdrKey	integer	None.
PLCovTypeHdrDesc	string	None.
FamilyId	string	None.
MemberName	string	None.
InEffectDate	date	None.
OutOfEffectDate	date	None.
TermDate	string	None.
CovPeriod	string	None.
TermReason	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MBEligibilityKey": 1,
    "PBEntityKey": 2,
    "MBMemberKey": 3,
    "PLPlanKey": 4,
    "PLPlanDesc": "sample string 5",
    "PLCovTypeHdrKey": 6,
    "PLCovTypeHdrDesc": "sample string 7",
    "FamilyId": "sample string 8",
    "MemberName": "sample string 9",
    "InEffectDate": "2025-11-03T00:03:56.8823893-06:00",
    "OutOfEffectDate": "2025-11-03T00:03:56.8823893-06:00",
    "TermDate": "11/3/2025",
    "CovPeriod": "11/3/202511/3/2025",
    "TermReason": "sample string 12"
  },
  {
    "MBEligibilityKey": 1,
    "PBEntityKey": 2,
    "MBMemberKey": 3,
    "PLPlanKey": 4,
    "PLPlanDesc": "sample string 5",
    "PLCovTypeHdrKey": 6,
    "PLCovTypeHdrDesc": "sample string 7",
    "FamilyId": "sample string 8",
    "MemberName": "sample string 9",
    "InEffectDate": "2025-11-03T00:03:56.8823893-06:00",
    "OutOfEffectDate": "2025-11-03T00:03:56.8823893-06:00",
    "TermDate": "11/3/2025",
    "CovPeriod": "11/3/202511/3/2025",
    "TermReason": "sample string 12"
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.