GET api/Doctors/light?specialtyID={specialtyID}&locationID={locationID}&gender={gender}&onlineAppts={onlineAppts}&virtualClinic={virtualClinic}
Get base doctor info with filter/search parameters
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
specialtyID |
Use 0 for all specialties |
integer |
Required |
locationID |
Use 0 for all locations |
integer |
Required |
gender |
'Male', 'Female' or empty string for all |
string |
Required |
onlineAppts |
'yes', 'no' or empty string for all |
string |
Required |
virtualClinic |
'yes', 'no' or empty string for all |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of DoctorLightName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
FirstName | string |
None. |
|
MiddleName | string |
None. |
|
LastName | string |
None. |
|
Title | string |
None. |
|
Phone | string |
None. |
|
ThumbUrl | string |
None. |
|
Fullname | string |
None. |
|
FullnameLastFirst | string |
None. |
|
PageUrl | string |
None. |
|
VideoUrl | string |
None. |
|
Specialties | Collection of Specialty |
None. |
|
AppointmentUrl | string |
None. |
|
VirtualClinic | boolean |
None. |
|
VirtualCareApptUrl | string |
None. |
|
TICProvider | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ID": 1, "FirstName": "sample string 2", "MiddleName": "sample string 3", "LastName": "sample string 4", "Title": "sample string 5", "Phone": "sample string 6", "ThumbUrl": "sample string 7", "Fullname": "sample string 2 sample string 3 sample string 4", "FullnameLastFirst": "sample string 4, sample string 2", "PageUrl": "https://iowaclinic.spinudev.com/doctors/d1/sample-string-2-sample-string-3-sample-string-4/", "VideoUrl": "sample string 8", "Specialties": [ { "ID": 1, "Title": "sample string 2", "Url": "sample string 3" }, { "ID": 1, "Title": "sample string 2", "Url": "sample string 3" } ], "AppointmentUrl": "sample string 9", "VirtualClinic": true, "VirtualCareApptUrl": "sample string 11", "TICProvider": true }, { "ID": 1, "FirstName": "sample string 2", "MiddleName": "sample string 3", "LastName": "sample string 4", "Title": "sample string 5", "Phone": "sample string 6", "ThumbUrl": "sample string 7", "Fullname": "sample string 2 sample string 3 sample string 4", "FullnameLastFirst": "sample string 4, sample string 2", "PageUrl": "https://iowaclinic.spinudev.com/doctors/d1/sample-string-2-sample-string-3-sample-string-4/", "VideoUrl": "sample string 8", "Specialties": [ { "ID": 1, "Title": "sample string 2", "Url": "sample string 3" }, { "ID": 1, "Title": "sample string 2", "Url": "sample string 3" } ], "AppointmentUrl": "sample string 9", "VirtualClinic": true, "VirtualCareApptUrl": "sample string 11", "TICProvider": true } ]
application/xml, text/xml
Sample:
<ArrayOfDoctorLight xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iowaclinic_api.API"> <DoctorLight> <AppointmentUrl>sample string 9</AppointmentUrl> <FirstName>sample string 2</FirstName> <ID>1</ID> <LastName>sample string 4</LastName> <MiddleName>sample string 3</MiddleName> <Phone>sample string 6</Phone> <Specialties> <DoctorLight.Specialty> <ID>1</ID> <Title>sample string 2</Title> <Url>sample string 3</Url> </DoctorLight.Specialty> <DoctorLight.Specialty> <ID>1</ID> <Title>sample string 2</Title> <Url>sample string 3</Url> </DoctorLight.Specialty> </Specialties> <TICProvider>true</TICProvider> <ThumbUrl>sample string 7</ThumbUrl> <Title>sample string 5</Title> <VideoUrl>sample string 8</VideoUrl> <VirtualCareApptUrl>sample string 11</VirtualCareApptUrl> <VirtualClinic>true</VirtualClinic> </DoctorLight> <DoctorLight> <AppointmentUrl>sample string 9</AppointmentUrl> <FirstName>sample string 2</FirstName> <ID>1</ID> <LastName>sample string 4</LastName> <MiddleName>sample string 3</MiddleName> <Phone>sample string 6</Phone> <Specialties> <DoctorLight.Specialty> <ID>1</ID> <Title>sample string 2</Title> <Url>sample string 3</Url> </DoctorLight.Specialty> <DoctorLight.Specialty> <ID>1</ID> <Title>sample string 2</Title> <Url>sample string 3</Url> </DoctorLight.Specialty> </Specialties> <TICProvider>true</TICProvider> <ThumbUrl>sample string 7</ThumbUrl> <Title>sample string 5</Title> <VideoUrl>sample string 8</VideoUrl> <VirtualCareApptUrl>sample string 11</VirtualCareApptUrl> <VirtualClinic>true</VirtualClinic> </DoctorLight> </ArrayOfDoctorLight>