Public API
Patient Functions
Surgeon Functions
General Functions
POST Doctor Profile
Returns profile information about the logged in doctor. Requires the LoginKey from Doctor Login.
Resource URL
https://testapi.surgiprice.com/doctor-profile/
Input Parameters
| Parameter Name | Description | Parameter Type | Required | Example |
|---|---|---|---|---|
| LoginKey | LoginKey for Logged in Doctor | 32 Characters | YES | 12345678901234567890123456789012 |
Result Description
| Parameter Name | Description | Parameter Type | Example |
|---|---|---|---|
| Success | If the information was retrieved from the database or not | 0 (fail) or 1 (success) | 0 |
| Message | If Success=0, this parameter contains the reason the api call failed. This is for feedback to the user. | String | Invalid LoginKey |
| FirstName | First Name | String | Aaron |
| MiddleName | Middle Name | String | Jay |
| LastName | Last Name | String | Lev |
| Doctor's Email | String | [email protected] | |
| MobilePhone | Mobile Phone | String | (555) 555-1212 |
| HomePhone | Home Phone | String | (555) 555-1212 |
| WorkPhone | Work Phone | String | (555) 555-1212 |
| Address1 | Address1 | String | 13 Cherry Lane |
| Address2 | Address2 | String | Suite 13 |
| City | City | String | Rockville |
| State | State | String | MD |
| Zip | Zip | String | 20852 |
| Specialty | The Doctor's Specialty | String | MD |
| SuffixName | The Doctor's Suffix Name | String | Dr. |
| NPI | NPI Number | String | 12345678 |
| CertificationExpires | The Certification Expiration Date | String | 12/25/2015 |
| Bio | Marketing BIO of the doctor for the patient | String | I like to get to know my patients so I can provide the best care possible. |
| MarketingURL1 | Marketing URL #1 | String | http://www.my-doctor-website/ |
| MarketingURL2 | Marketing URL #2 | String | http://www.my-doctor-website/ |
| MarketingURL3 | Marketing URL #3 | String | http://www.my-doctor-website/ |
| AgreementIPAddress | Agreement IP Address | String | 10.10.10.10 |
| AgreementTime | Agreement Time | String | 2016-12-19 09:02:57 |
| AdditionalLocations | Additional Office Locations | Array | See Below |
| FacilityID | Doctor's Employer | Integer | 0 = Not Employed or 213 = Facility ID |
| CertificationName | Doctor's Certification Name | String | |
| CertificationExpires | Doctor's Certification Expiration Date | Date | 5/2/2027 |
| CertificationLastUploadedDate | Date Doctor's Certification Last Uploaded | Date | 5/2/2017 |
| DoctorNotes | Doctor's Notes | Text | I have a recovery area. |
Additional Location Record
| Parameter Name | Description | Parameter Type | Example |
|---|---|---|---|
| DoctorLocationID | Doctor Location ID | Number | 10062 |
| RecordAdded | Date Record Added | Date | 2015-11-01 09:23:09 |
| DoctorID | Doctor ID | Number | 1042 |
| LocationName | Location Name | String | My other office |
| Address1 | Address1 | String | 13 Cherry Lane |
| Address2 | Address2 | String | Suite 1013 |
| City | City | String | Rockville |
| State | State | String | MD |
| Zip | Zip | String | 20852 |
| CountryCode | Country Code | String | USA |
| string | [email protected] | ||
| Phone | Phone | String | (555) 555-1212 |
| ContactName | Contact Name | String | Aaron Jay Lev |
| Status | Status | String | Active |