Public API
Patient Functions
Surgeon Functions
General Functions
POST Patient Procedure Add/Update
Add or Update Information on Procedure in SurgiPrice™. Requires the LoginKey from Login.
Resource URL
https://testapi.surgiprice.com/procedure-edit/
Input Parameters
Parameter Name | Description | Parameter Type | Required | Example |
---|---|---|---|---|
LoginKey | LoginKey for Logged in Patient | 32 Characters | YES | 12345678901234567890123456789012 |
ProcedureID | Procedure ID to update or the string "Add" to add a new procdure | Integer (to update) or "Add" to Add | YES | 2 |
Pref_Distance | Preferred Distance | String | YES | Under 100 miles |
PatientChoice1 | Patient's First Choice (DoctorID) or 0 | Integer | YES | 1 |
PatientChoice2 | Patient's Second Choice (DoctorID) or 0 | Integer | YES | 2 |
ProcedureTypeID | Procedure Type ID | Integer | YES | 2 |
Pref_DOW_Sun | Preferred Day of Week - Sunday | Boolean | YES | (0 or 1) |
Pref_DOW_Mon | Preferred Day of Week - Monday | Boolean | YES | (0 or 1) |
Pref_DOW_Tue | Preferred Day of Week - Tuesday | Boolean | YES | (0 or 1) |
Pref_DOW_Wed | Preferred Day of Week - Wednesday | Boolean | YES | (0 or 1) |
Pref_DOW_Thu | Preferred Day of Week - Thursday | Boolean | YES | (0 or 1) |
Pref_DOW_Fri | Preferred Day of Week - Friday | Boolean | YES | (0 or 1) |
Pref_DOW_Sat | Preferred Day of Week - Saturday | Boolean | YES | (0 or 1) |
Pref_StartingDate | Preferred Starting Date | Date as String | YES | 10/16/2014 (or blank) |
Pref_EndingDate | Preferred Ending Date | Date as String | YES | 10/22/2014 (or blank) |
Result Description
Parameter Name | Description | Parameter Type | Example |
---|---|---|---|
Success | If the information was updated in / added to the database or not | 0 (fail) or 1 (success) | 0 |
Message | If Success=0, this parameter contains the reason the procedure view failed. This is for feedback to the user. |
String | Invalid ProcedureID |