The Iowa Clinic Web API Help Page

Introduction

Provide a general description of your APIs here.

ProviderNews

API	Description
GET api/ReferralDirectory/ProviderNews	Get all current provider news from last 60 days for Referral Directory App
GET api/ReferralDirectory/ProviderNews/{newsID}	Get provider news for the Referral Directory App

Locations

API	Description
GET api/Doctors/{doctorID}/Locations	Get doctor locations by doctor ID
GET api/Locations	Get all active locations
GET api/Locations?mainOnly={mainOnly}&specialtyID={specialtyID}&city={city}	Get locations with filter/search parameters
GET api/Locations/{id}	Get location by ID

OnCallSpecialties

API	Description
GET api/OnCallSpecialties/{id}	Get on call specialty by ID
GET api/OnCallSpecialties	Get list of specialties

Doctors

API	Description
GET api/Doctors/{id}	Get doctor by ID
GET api/Doctors/light?specialtyID={specialtyID}&locationID={locationID}&gender={gender}&onlineAppts={onlineAppts}&virtualClinic={virtualClinic}	Get base doctor info with filter/search parameters
GET api/Locations/{locationID}/Doctors	Get doctors by location ID
GET api/Specialties/{specialtyID}/Doctors	Get doctors by specialty ID
GET api/ReferralDirectory/Specialties/{specialtyID}/Doctors	Get doctors by specialty ID for Referral Directory App
GET api/ReferralDirectory/OnCallSpecialties/{specialtyID}/doctors	Get doctors by on call specialty by ID for the Referral Directory App
GET api/ReferralDirectory/Doctors/type/{providerType}	Get doctors by provider type for the Referral Directory App. Can call individually or by comma separated for multiple e.g. api/doctors/type/1 or api/doctors/type/1,4
GET api/Doctors	Get all active doctors
GET api/Doctors?specialtyID={specialtyID}&locationID={locationID}&gender={gender}&onlineAppts={onlineAppts}&virtualClinic={virtualClinic}	Get doctors with filter/search parameters

ProviderVideo

API	Description
GET api/ReferralDirectory/ProviderVideo	Get all current provider videos from last 60 days for Referral Directory App
GET api/ReferralDirectory/ProviderVideo/{videoID}	Get provider videos for the Referral Directory App

Specialties

API	Description
GET api/Doctors/{doctorID}/Specialties	Get doctor specialties by doctor ID
GET api/Locations/{locationID}/Specialties	Get location specialties by location ID
GET api/ReferralDirectory/Specialties	Get list of specialties for Referral Direcory App
GET api/Specialties	Get list of specialties

ScheduleOnline

API	Description
GET api/ScheduleOnline	Get all active schedule online services
GET api/ScheduleOnline/{id}	Get schedule online service by ID

Cities

API	Description
GET api/Cities	Get list of cities for all active locations