WebService
The following operations are supported. For a formal definition, please review the Service Description.
-
GetInsuranceCarriersAndPlans
Retrieves a list of insurance carrier names and all plan names for each carrier, and their accompanying integer id's. -
GetProfessional
Returns the doctor or dentist requested with name, location, average patient rating (from 1 to 5, or -1 if no ratings yet) and url where more information can be found. The dentist/doctor element will have a nested list of Opening elements. The Opening element will have a time, and an url which leads to www.zocdoc.com where the opening can be booked by the user.
Arguments:
Key: An access key to use the web service. You can get one at http://www.zocdoc.com/remote/WebServiceRegister.aspx
ProfessionalUrl: The url from the dentist/doctor element returned by the Search function. -
GetProfessionalByName
Returns the doctor or dentist requested with name, location, average patient rating (from 1 to 5, or -1 if no ratings yet) and url where more information can be found. The dentist/doctor element will have a nested list of Opening elements. The Opening element will have a time, and an url which leads to www.zocdoc.com where the opening can be booked by the user.
Arguments:
Key: An access key to use the web service. You can get one at http://www.zocdoc.com/remote/WebServiceRegister.aspx
FirstName: The first name of the doctor/dentist.
LastName: The last name of the doctor/dentist. -
GetSpecialtiesAndVisitReasons
Retrieves a list of doctor and dentist specialties that are currently active on ZocDoc. Also returns a list of possible visit reasons for each specialty. Returns accompanying integer id's for both specialties and visit reasons. -
Search
Returns a list of available openings with dentists/doctors that match the criteria searched for. Returns a list of dentists/doctors, each with name, location, average patient rating (from 1 to 5, or -1 if no ratings yet) and url where more information can be found. Each dentist/doctor element will have a nested list of Opening elements. The Opening element will have a time, and an url which leads to www.zocdoc.com where the opening can be booked by the user.
Arguments:
Key: An access key to use the web service. You can get one at http://www.zocdoc.com/remote/WebServiceRegister.aspx
apptRangeBegin: Search for available openings beginning on this date. If using HTTP GET method, pass in a string of the format MM/dd/yyyy.
apptRangeEnd: Search for available openings before this date. If using HTTP GET method, pass in a string of the format MM/dd/yyyy.
address: Search for openings near this address. Can be in any format that is parseable by google maps, i.e. "10003" or "New York, NY", etc.
specialty: An integer id. Search for openings from doctors/dentists that have this specialty. List of id's for specialties can be found by invoking the GetSpecialtiesAndVisitReasons web service method.
visitReason: An integer id. Search for openings for this visit reason. List of id's for visit reasons can be found by invoking the GetSpecialtiesAndVisitReasons web service method.
insuranceCarrier: An integer id. Search results will report whether each doctor/dentist accepts this insurance. To ignore this field, pass in the integer value "-1" as the argument. If this field is used, the doctor element will contain a sub-element, InsuranceStatus, that specifies whether this doctor is in network for this insurance, files paperwork for this insurance, or neither. If insuranceCarrier is used, insurancePlan must be filled out as well. A list of insurance carriers, plans, and accompanying id's can be found by invoking the GetInsuranceCarriersAndPlans web service method.
insurancePlan: An integer id. Search results will report whether each doctor/dentist accepts this insurance plan. To ignore this field, pass in the integer value "-1" as the argument. If this field is used, insuranceCarrier must be filled out as well.