Public API
Patient Functions
Surgeon Functions
General Functions
POST Patient Profile View
Used to get profile information about a patient in SurgiPrice™. Requires the LoginKey from Login.
Resource URL
https://testapi.surgiprice.com/profile/
Input Parameters
| Parameter Name | Description | Parameter Type | Required | Example |
|---|---|---|---|---|
| LoginKey | LoginKey for Logged in Patient | 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 |
| PatientID | Patient ID | String | 10000 |
| RecordAdded | Date Patient Record was created | String | 10/23/14 5:07 am |
| FirstName | First Name | String | Aaron |
| MiddleName | Middle Name | String | Jay |
| LastName | Last Name | String | Lev |
| String | [email protected] | ||
| MobilePhone | Mobile Phone | String | (555) 555-1212 |
| HomePhone | Home Phone | String | (555) 555-1213 |
| WorkPhone | Work Phone | String | (555) 555-1214 |
| Address1 | Address1 | String | 1101 Wootton Pkway |
| Address2 | Address2 | String | Suite 900 |
| City | City | String | Rockville |
| State | State | String | MD |
| Zip | Zip | String | 20852 |
| CountryCode | Country Code | String | USA |
| Manager | Manager Name (Navigator) | String | Marshall Besch |
| Procedures | Summary of Procedures for Patient | Array | |
| Procedures - ProcedureID | Procedure ID | Integer | 2 |
| Procedures - Date | Procedure Date | Date (as String) | 10/29/2014 |
| Procedures - ProcedureTypeName | Procedure Type Name | String | Percutaneous coronary angioplasty (PTCA) |
| Procedures - Status | Procedure Status | String | Pending |
| Message | If Success=0, this parameter contains the reason the profile lookup failed. This is for feedback to the user. |
String | Email was invalid |