Public API
Patient Functions
Surgeon Functions
General Functions
POST Patient Login
Used to login a patient to SurgiPrice™ and receive an authentication key.
Resource URL
https://testapi.surgiprice.com/login/
Input Parameters
| Parameter Name | Description | Parameter Type | Required | Example |
|---|---|---|---|---|
| Patient's Email Address | 50 Characters | YES | [email protected] | |
| Password | Patient's Password | 20 Characters | no | My1stPassword! |
Result Description
| Parameter Name | Description | Parameter Type | Example |
|---|---|---|---|
| Success | If the email / password combination was correct | 0 (fail) or 1 (success) | 0 |
| LoginKey | A 20 digit string used to authenticate the user for the rest of the session | 20 Characters | 12345678901234567890 |
| Message | If Success=0, this Parameter contains the reason the login failed. This is for feedback to the user. | String | That was an invalid email / password combination |