GET api/Member/GetBenefits?TargetEntity={TargetEntity}&MemberID={MemberID}&HICNumber={HICNumber}&DateOfService={DateOfService}&CompanyID={CompanyID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| TargetEntity | TargetEntity |
None. |
|
| MemberID | string |
None. |
|
| HICNumber | string |
None. |
|
| DateOfService | date |
Required |
|
| CompanyID | Company |
None. |
Body Parameters
None.
Request Formats
text/json, application/json
Sample:
Request sample for request
--------------------------------------------------------------------------------------------------------------------------------
{
"TargetEntity": 0,
"MemberID": "sample string 1",
"HICNumber": "sample string 2",
"DateOfService": "2026-06-03T09:19:53.6148095-07:00",
"CompanyID": 0
}
--------------------------------------------------------------------------------------------------------------------------------
text/xml, application/xml
Sample:
Request sample for request -------------------------------------------------------------------------------------------------------------------------------- <BenefitRequestDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CompanyID>None</CompanyID> <DateOfService>2026-06-03T09:19:53.6304344-07:00</DateOfService> <HICNumber>sample string 2</HICNumber> <MemberID>sample string 1</MemberID> <TargetEntity>None</TargetEntity> </BenefitRequestDTO> --------------------------------------------------------------------------------------------------------------------------------
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
text/json, application/json
Sample:
--------------------------------------------------------------------------------------------------------------------------------
{
"MemberPersonalInfo": {
"DateOfBirth": "sample string 1",
"Sex": "sample string 2",
"ID": "sample string 3",
"GenderSelfIdentificationCode": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"MI": "sample string 7",
"Suffix": "sample string 8",
"Prefix": "sample string 9",
"Ethnicity": [
{
"Label": "sample string 1",
"Value": "sample string 2"
},
{
"Label": "sample string 1",
"Value": "sample string 2"
}
],
"Race": [
{
"Label": "sample string 1",
"Value": "sample string 2"
},
{
"Label": "sample string 1",
"Value": "sample string 2"
}
]
},
"EffectiveDate": "2026-06-03T09:19:53.7204493-07:00",
"TermDate": "2026-06-03T09:19:53.7204493-07:00",
"PlanDetails": {
"PBP": "sample string 1",
"ContractCode": "sample string 2",
"SupplementalBuyup": true,
"SupplementalEffectiveDate": "2026-06-03T09:19:53.7204493-07:00",
"SupplementalEndDate": "2026-06-03T09:19:53.7204493-07:00",
"PBPDesc": "sample string 4"
},
"OPT": "sample string 1",
"OPTDesc": "sample string 2",
"County": "sample string 3",
"IPA": {
"Code": "sample string 1",
"Description": "sample string 2",
"Phone": "sample string 3"
},
"PCP": {
"Id": "sample string 1",
"Name": "sample string 2",
"EffectivePeriod": "sample string 3"
},
"MemberAccumulator": {
"HIC": "sample string 1",
"MedicalOOP": "sample string 2",
"InNtwkCopayAmt": "sample string 3",
"InNtwkCoInsuranceAmt": "sample string 4",
"InNtwkDeductibleAmt": "sample string 5",
"OutNtwkCopayAmt": "sample string 6",
"OutNtwkCoInsuranceAmt": "sample string 7",
"OutNtwkDeductibleAmt": "sample string 8",
"InNetworkMedicalOOP": "sample string 9",
"OutNetworkMedicalOOP": "sample string 10",
"CombinedCopayAmt": "sample string 11",
"CombinedCoInsuranceAmt": "sample string 12",
"CombinedDeductibleAmt": "sample string 13",
"CombinedOOP": "sample string 14"
},
"Benefits": [
{
"Name": "sample string 1",
"Description": "sample string 2",
"Attributes": "sample string 3"
},
{
"Name": "sample string 1",
"Description": "sample string 2",
"Attributes": "sample string 3"
}
],
"HICNumber": "sample string 4",
"MedicareId": "sample string 5",
"QMBStatus": "sample string 6",
"COBInsuranceInfo": {
"InsurerName": "sample string 1",
"InsurerType": "sample string 2",
"Address": "sample string 3",
"PhoneNo": "sample string 4",
"PolicyNo": "sample string 5",
"COBStatus": "sample string 6",
"COBEffectiveDate": "2026-06-03T09:19:53.7204493-07:00",
"COBTermDate": "2026-06-03T09:19:53.7204493-07:00",
"EffDtofOtherDrugCoverage": "2026-06-03T09:19:53.7204493-07:00"
},
"MediCal": "sample string 7",
"MedicaidEffectiveDate": "2026-06-03T09:19:53.7204493-07:00",
"MedicaidEndDate": "2026-06-03T09:19:53.7204493-07:00",
"MedicaidLevel": "sample string 8",
"ShareOfCost": "sample string 9",
"ConfirmationNumber": "sample string 10",
"Notes": "sample string 11",
"ProcessingStatusList": [
{
"StatusCode": "sample string 1",
"StatusDescription": "sample string 2"
},
{
"StatusCode": "sample string 1",
"StatusDescription": "sample string 2"
}
]
}
--------------------------------------------------------------------------------------------------------------------------------
text/xml, application/xml
Sample:
--------------------------------------------------------------------------------------------------------------------------------
<BenefitResponseDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ProcessingStatusList xmlns="http://schemas.datacontract.org/2004/07/AHC.Core.Web.DTOs" xmlns:a="http://schemas.datacontract.org/2004/07/AHC.Core">
<a:ProcessingStatus>
<a:StatusCode>sample string 1</a:StatusCode>
<a:StatusDescription>sample string 2</a:StatusDescription>
</a:ProcessingStatus>
<a:ProcessingStatus>
<a:StatusCode>sample string 1</a:StatusCode>
<a:StatusDescription>sample string 2</a:StatusDescription>
</a:ProcessingStatus>
</ProcessingStatusList>
<ConfirmationNumber xmlns="http://schemas.datacontract.org/2004/07/AHC.Core.Web.DTOs">sample string 10</ConfirmationNumber>
<EstimatedFulfillmentDate xmlns="http://schemas.datacontract.org/2004/07/AHC.Core.Web.DTOs">2026-06-03T09:19:53.7204493-07:00</EstimatedFulfillmentDate>
<Notes xmlns="http://schemas.datacontract.org/2004/07/AHC.Core.Web.DTOs">sample string 11</Notes>
<Benefits>
<Benefit>
<Attributes>sample string 3</Attributes>
<Description>sample string 2</Description>
<Name>sample string 1</Name>
</Benefit>
<Benefit>
<Attributes>sample string 3</Attributes>
<Description>sample string 2</Description>
<Name>sample string 1</Name>
</Benefit>
</Benefits>
<COBInsuranceInfo>
<Address>sample string 3</Address>
<COBEffectiveDate>2026-06-03T09:19:53.7204493-07:00</COBEffectiveDate>
<COBStatus>sample string 6</COBStatus>
<COBTermDate>2026-06-03T09:19:53.7204493-07:00</COBTermDate>
<EffDtofOtherDrugCoverage>2026-06-03T09:19:53.7204493-07:00</EffDtofOtherDrugCoverage>
<InsurerName>sample string 1</InsurerName>
<InsurerType>sample string 2</InsurerType>
<PhoneNo>sample string 4</PhoneNo>
<PolicyNo>sample string 5</PolicyNo>
</COBInsuranceInfo>
<County>sample string 3</County>
<EffectiveDate>2026-06-03T09:19:53.7204493-07:00</EffectiveDate>
<HICNumber>sample string 4</HICNumber>
<IPA>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<Phone>sample string 3</Phone>
</IPA>
<MediCal>sample string 7</MediCal>
<MedicaidEffectiveDate>2026-06-03T09:19:53.7204493-07:00</MedicaidEffectiveDate>
<MedicaidEndDate>2026-06-03T09:19:53.7204493-07:00</MedicaidEndDate>
<MedicaidLevel>sample string 8</MedicaidLevel>
<MedicareId>sample string 5</MedicareId>
<MemberAccumulator>
<CombinedCoInsuranceAmt>sample string 12</CombinedCoInsuranceAmt>
<CombinedCopayAmt>sample string 11</CombinedCopayAmt>
<CombinedDeductibleAmt>sample string 13</CombinedDeductibleAmt>
<CombinedOOP>sample string 14</CombinedOOP>
<HIC>sample string 1</HIC>
<InNetworkMedicalOOP>sample string 9</InNetworkMedicalOOP>
<InNtwkCoInsuranceAmt>sample string 4</InNtwkCoInsuranceAmt>
<InNtwkCopayAmt>sample string 3</InNtwkCopayAmt>
<InNtwkDeductibleAmt>sample string 5</InNtwkDeductibleAmt>
<MedicalOOP>sample string 2</MedicalOOP>
<OutNetworkMedicalOOP>sample string 10</OutNetworkMedicalOOP>
<OutNtwkCoInsuranceAmt>sample string 7</OutNtwkCoInsuranceAmt>
<OutNtwkCopayAmt>sample string 6</OutNtwkCopayAmt>
<OutNtwkDeductibleAmt>sample string 8</OutNtwkDeductibleAmt>
</MemberAccumulator>
<MemberPersonalInfo xmlns:a="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.CommonDTOs">
<a:Ethnicity>
<EthnicityInfo>
<Label>sample string 1</Label>
<Value>sample string 2</Value>
</EthnicityInfo>
<EthnicityInfo>
<Label>sample string 1</Label>
<Value>sample string 2</Value>
</EthnicityInfo>
</a:Ethnicity>
<a:FirstName>sample string 5</a:FirstName>
<a:LastName>sample string 6</a:LastName>
<a:MI>sample string 7</a:MI>
<a:Prefix>sample string 9</a:Prefix>
<a:Race>
<RaceInfo>
<Label>sample string 1</Label>
<Value>sample string 2</Value>
</RaceInfo>
<RaceInfo>
<Label>sample string 1</Label>
<Value>sample string 2</Value>
</RaceInfo>
</a:Race>
<a:Suffix>sample string 8</a:Suffix>
<a:DateOfBirth>sample string 1</a:DateOfBirth>
<a:GenderSelfIdentificationCode>sample string 4</a:GenderSelfIdentificationCode>
<a:ID>sample string 3</a:ID>
<a:Sex>sample string 2</a:Sex>
</MemberPersonalInfo>
<OPT>sample string 1</OPT>
<OPTDesc>sample string 2</OPTDesc>
<PCP>
<EffectivePeriod>sample string 3</EffectivePeriod>
<Id>sample string 1</Id>
<Name>sample string 2</Name>
</PCP>
<PlanDetails>
<ContractCode>sample string 2</ContractCode>
<PBP>sample string 1</PBP>
<PBPDesc>sample string 4</PBPDesc>
<SupplementalBuyup>true</SupplementalBuyup>
<SupplementalEffectiveDate>2026-06-03T09:19:53.7204493-07:00</SupplementalEffectiveDate>
<SupplementalEndDate>2026-06-03T09:19:53.7204493-07:00</SupplementalEndDate>
</PlanDetails>
<QMBStatus>sample string 6</QMBStatus>
<ShareOfCost>sample string 9</ShareOfCost>
<TermDate>2026-06-03T09:19:53.7204493-07:00</TermDate>
</BenefitResponseDTO>
--------------------------------------------------------------------------------------------------------------------------------