GET api/ProviderSearch/Search
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| AcceptNew | character |
None. |
|
| AccreditingOrg | string |
None. |
|
| BoardCert | string |
None. |
|
| City | string |
None. |
|
| FacilityTOS | string |
None. |
|
| ForeignLanguage | string |
None. |
|
| Gender | character |
None. |
|
| Hosp | string |
None. |
|
| MedGrp | string |
None. |
|
| Name | string |
None. |
|
| Network | string |
None. |
|
| OfficeLocation | string |
None. |
|
| PartIn | string |
None. |
|
| ProvType | string |
None. |
|
| Radius | string |
None. |
|
| SessionID | string |
None. |
|
| Specialty | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| GetCountOnly | boolean |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ProviderSearchQueryResults| Name | Description | Type | Additional information |
|---|---|---|---|
| ProviderResults | Collection of ProviderSearchResult |
None. |
|
| Query | ProviderSearchQuery |
None. |
|
| ErrorMessage | string |
None. |
|
| NextPage | string |
None. |
|
| PreviousPage | string |
None. |
|
| ResultCount | integer |
None. |
|
| Success | boolean |
None. |
|
| TotalResultCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"ProviderResults": [
{
"AcceptPT": true,
"Accred": "sample string 2",
"AccredDate": "2026-08-20T21:41:52.4091501-04:00",
"Address1": "sample string 3",
"Address2": "sample string 4",
"AddressType": "sample string 5",
"BoardCertifications": "sample string 6",
"City": "sample string 7",
"County": "sample string 8",
"CulturalTrainingDate": "2026-08-20T21:41:52.4091501-04:00",
"DateCreated": "2026-08-20T21:41:52.4091501-04:00",
"Distance": 10.1,
"ForeignLanguages": "sample string 11",
"Gender": "sample string 12",
"Hospitals": "sample string 13",
"ID": 14,
"LastName": "sample string 15",
"LastUpdatedDate": "2026-08-20T21:41:52.4091501-04:00",
"MedGrp": "sample string 16",
"Name": "sample string 17",
"Name2": "sample string 18",
"NotHandicapAccessible": true,
"OHMedicaid": "sample string 20",
"Par": true,
"Phone": "sample string 22",
"PlanParticipation": "sample string 23",
"ProviderID": "sample string 24",
"Restrictions": "sample string 25",
"Section": 26,
"SessionID": "sample string 27",
"Specialty": "sample string 28",
"State": "sample string 29",
"WVMedicaid": "sample string 30",
"Website": "sample string 31",
"WvuTier": "sample string 32",
"WvuhMedicareTier": "sample string 33",
"Zip": "sample string 34"
},
{
"AcceptPT": true,
"Accred": "sample string 2",
"AccredDate": "2026-08-20T21:41:52.4091501-04:00",
"Address1": "sample string 3",
"Address2": "sample string 4",
"AddressType": "sample string 5",
"BoardCertifications": "sample string 6",
"City": "sample string 7",
"County": "sample string 8",
"CulturalTrainingDate": "2026-08-20T21:41:52.4091501-04:00",
"DateCreated": "2026-08-20T21:41:52.4091501-04:00",
"Distance": 10.1,
"ForeignLanguages": "sample string 11",
"Gender": "sample string 12",
"Hospitals": "sample string 13",
"ID": 14,
"LastName": "sample string 15",
"LastUpdatedDate": "2026-08-20T21:41:52.4091501-04:00",
"MedGrp": "sample string 16",
"Name": "sample string 17",
"Name2": "sample string 18",
"NotHandicapAccessible": true,
"OHMedicaid": "sample string 20",
"Par": true,
"Phone": "sample string 22",
"PlanParticipation": "sample string 23",
"ProviderID": "sample string 24",
"Restrictions": "sample string 25",
"Section": 26,
"SessionID": "sample string 27",
"Specialty": "sample string 28",
"State": "sample string 29",
"WVMedicaid": "sample string 30",
"Website": "sample string 31",
"WvuTier": "sample string 32",
"WvuhMedicareTier": "sample string 33",
"Zip": "sample string 34"
}
],
"Query": {
"AcceptNew": "A",
"AccreditingOrg": "sample string 2",
"BoardCert": "sample string 3",
"City": "sample string 4",
"FacilityTOS": "sample string 5",
"ForeignLanguage": "sample string 6",
"Gender": "A",
"Hosp": "sample string 8",
"MedGrp": "sample string 9",
"Name": "sample string 10",
"Network": "sample string 11",
"OfficeLocation": "sample string 12",
"PartIn": "sample string 13",
"ProvType": "sample string 14",
"Radius": "sample string 15",
"SessionID": "sample string 16",
"Specialty": "sample string 17",
"State": "sample string 18",
"Zip": "sample string 19",
"GetCountOnly": true,
"PageNumber": 21,
"PageSize": 22
},
"ErrorMessage": "sample string 1",
"NextPage": "sample string 2",
"PreviousPage": "sample string 3",
"ResultCount": 4,
"Success": true,
"TotalResultCount": 6
}
text/html
Sample:
{"ProviderResults":[{"AcceptPT":true,"Accred":"sample string 2","AccredDate":"2026-08-20T21:41:52.4091501-04:00","Address1":"sample string 3","Address2":"sample string 4","AddressType":"sample string 5","BoardCertifications":"sample string 6","City":"sample string 7","County":"sample string 8","CulturalTrainingDate":"2026-08-20T21:41:52.4091501-04:00","DateCreated":"2026-08-20T21:41:52.4091501-04:00","Distance":10.1,"ForeignLanguages":"sample string 11","Gender":"sample string 12","Hospitals":"sample string 13","ID":14,"LastName":"sample string 15","LastUpdatedDate":"2026-08-20T21:41:52.4091501-04:00","MedGrp":"sample string 16","Name":"sample string 17","Name2":"sample string 18","NotHandicapAccessible":true,"OHMedicaid":"sample string 20","Par":true,"Phone":"sample string 22","PlanParticipation":"sample string 23","ProviderID":"sample string 24","Restrictions":"sample string 25","Section":26,"SessionID":"sample string 27","Specialty":"sample string 28","State":"sample string 29","WVMedicaid":"sample string 30","Website":"sample string 31","WvuTier":"sample string 32","WvuhMedicareTier":"sample string 33","Zip":"sample string 34"},{"AcceptPT":true,"Accred":"sample string 2","AccredDate":"2026-08-20T21:41:52.4091501-04:00","Address1":"sample string 3","Address2":"sample string 4","AddressType":"sample string 5","BoardCertifications":"sample string 6","City":"sample string 7","County":"sample string 8","CulturalTrainingDate":"2026-08-20T21:41:52.4091501-04:00","DateCreated":"2026-08-20T21:41:52.4091501-04:00","Distance":10.1,"ForeignLanguages":"sample string 11","Gender":"sample string 12","Hospitals":"sample string 13","ID":14,"LastName":"sample string 15","LastUpdatedDate":"2026-08-20T21:41:52.4091501-04:00","MedGrp":"sample string 16","Name":"sample string 17","Name2":"sample string 18","NotHandicapAccessible":true,"OHMedicaid":"sample string 20","Par":true,"Phone":"sample string 22","PlanParticipation":"sample string 23","ProviderID":"sample string 24","Restrictions":"sample string 25","Section":26,"SessionID":"sample string 27","Specialty":"sample string 28","State":"sample string 29","WVMedicaid":"sample string 30","Website":"sample string 31","WvuTier":"sample string 32","WvuhMedicareTier":"sample string 33","Zip":"sample string 34"}],"Query":{"AcceptNew":"A","AccreditingOrg":"sample string 2","BoardCert":"sample string 3","City":"sample string 4","FacilityTOS":"sample string 5","ForeignLanguage":"sample string 6","Gender":"A","Hosp":"sample string 8","MedGrp":"sample string 9","Name":"sample string 10","Network":"sample string 11","OfficeLocation":"sample string 12","PartIn":"sample string 13","ProvType":"sample string 14","Radius":"sample string 15","SessionID":"sample string 16","Specialty":"sample string 17","State":"sample string 18","Zip":"sample string 19","GetCountOnly":true,"PageNumber":21,"PageSize":22},"ErrorMessage":"sample string 1","NextPage":"sample string 2","PreviousPage":"sample string 3","ResultCount":4,"Success":true,"TotalResultCount":6}
application/xml, text/xml
Sample:
<ProviderSearchQueryResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TheHealthPlan.Library.ProviderSearch">
<ErrorMessage>sample string 1</ErrorMessage>
<NextPage>sample string 2</NextPage>
<PreviousPage>sample string 3</PreviousPage>
<ResultCount>4</ResultCount>
<Success>true</Success>
<TotalResultCount>6</TotalResultCount>
<ProviderResults>
<ProviderSearchResult>
<AcceptPT>true</AcceptPT>
<Accred>sample string 2</Accred>
<AccredDate>2026-08-20T21:41:52.4091501-04:00</AccredDate>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressType>sample string 5</AddressType>
<BoardCertifications>sample string 6</BoardCertifications>
<City>sample string 7</City>
<County>sample string 8</County>
<CulturalTrainingDate>2026-08-20T21:41:52.4091501-04:00</CulturalTrainingDate>
<DateCreated>2026-08-20T21:41:52.4091501-04:00</DateCreated>
<Distance>10.1</Distance>
<ForeignLanguages>sample string 11</ForeignLanguages>
<Gender>sample string 12</Gender>
<Hospitals>sample string 13</Hospitals>
<ID>14</ID>
<LastName>sample string 15</LastName>
<LastUpdatedDate>2026-08-20T21:41:52.4091501-04:00</LastUpdatedDate>
<MedGrp>sample string 16</MedGrp>
<Name>sample string 17</Name>
<Name2>sample string 18</Name2>
<NotHandicapAccessible>true</NotHandicapAccessible>
<OHMedicaid>sample string 20</OHMedicaid>
<Par>true</Par>
<Phone>sample string 22</Phone>
<PlanParticipation>sample string 23</PlanParticipation>
<ProviderID>sample string 24</ProviderID>
<Restrictions>sample string 25</Restrictions>
<Section>26</Section>
<SessionID>sample string 27</SessionID>
<Specialty>sample string 28</Specialty>
<State>sample string 29</State>
<WVMedicaid>sample string 30</WVMedicaid>
<Website>sample string 31</Website>
<WvuTier>sample string 32</WvuTier>
<WvuhMedicareTier>sample string 33</WvuhMedicareTier>
<Zip>sample string 34</Zip>
</ProviderSearchResult>
<ProviderSearchResult>
<AcceptPT>true</AcceptPT>
<Accred>sample string 2</Accred>
<AccredDate>2026-08-20T21:41:52.4091501-04:00</AccredDate>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressType>sample string 5</AddressType>
<BoardCertifications>sample string 6</BoardCertifications>
<City>sample string 7</City>
<County>sample string 8</County>
<CulturalTrainingDate>2026-08-20T21:41:52.4091501-04:00</CulturalTrainingDate>
<DateCreated>2026-08-20T21:41:52.4091501-04:00</DateCreated>
<Distance>10.1</Distance>
<ForeignLanguages>sample string 11</ForeignLanguages>
<Gender>sample string 12</Gender>
<Hospitals>sample string 13</Hospitals>
<ID>14</ID>
<LastName>sample string 15</LastName>
<LastUpdatedDate>2026-08-20T21:41:52.4091501-04:00</LastUpdatedDate>
<MedGrp>sample string 16</MedGrp>
<Name>sample string 17</Name>
<Name2>sample string 18</Name2>
<NotHandicapAccessible>true</NotHandicapAccessible>
<OHMedicaid>sample string 20</OHMedicaid>
<Par>true</Par>
<Phone>sample string 22</Phone>
<PlanParticipation>sample string 23</PlanParticipation>
<ProviderID>sample string 24</ProviderID>
<Restrictions>sample string 25</Restrictions>
<Section>26</Section>
<SessionID>sample string 27</SessionID>
<Specialty>sample string 28</Specialty>
<State>sample string 29</State>
<WVMedicaid>sample string 30</WVMedicaid>
<Website>sample string 31</Website>
<WvuTier>sample string 32</WvuTier>
<WvuhMedicareTier>sample string 33</WvuhMedicareTier>
<Zip>sample string 34</Zip>
</ProviderSearchResult>
</ProviderResults>
<Query>
<GetCountOnly>true</GetCountOnly>
<PageNumber>21</PageNumber>
<PageSize>22</PageSize>
<AcceptNew>65</AcceptNew>
<AccreditingOrg>sample string 2</AccreditingOrg>
<BoardCert>sample string 3</BoardCert>
<City>sample string 4</City>
<FacilityTOS>sample string 5</FacilityTOS>
<ForeignLanguage>sample string 6</ForeignLanguage>
<Gender>65</Gender>
<Hosp>sample string 8</Hosp>
<MedGrp>sample string 9</MedGrp>
<Name>sample string 10</Name>
<Network>sample string 11</Network>
<OfficeLocation>sample string 12</OfficeLocation>
<PartIn>sample string 13</PartIn>
<ProvType>sample string 14</ProvType>
<Radius>sample string 15</Radius>
<SessionID>sample string 16</SessionID>
<Specialty>sample string 17</Specialty>
<State>sample string 18</State>
<Zip>sample string 19</Zip>
</Query>
</ProviderSearchQueryResults>