e-health service - web api

48
E-HEALTH SERVICE - Web API http://ehealth-service.azurewebsites.net/Help[1/19/2013 16:53:19] E-HEALTH SERVICE - Web API Patients API Description GET api/Patients/Get? username={username}&password={password} This method returns all patients of a doctor. GET api/Patients/Get/{id}? username={username}&password={password} This method returns detials of a single patient. POST api/Patients/Post? username={username}&password={password} This method adds a new patient and creates his medical record. PUT api/Patients/Put/{id}? username={username}&password={password} This method is used by a doctor to update patient's information. PUT api/Patients/address/{id}? username={username}&password={password} This method is used by a patient to update his location. DELETE api/Patients/Delete/{id}? username={username}&password={password} This method deletes a patient and his medical record. POST api/Patients/email/{id}? username={username}&password={password} This method sends an email, used by doctors. Alarms API Description GET api/Alarms/doctorAlarms? username={username}&password={password} This method returns the list of alarms sent by doctors. GET api/Alarms/patientAlarms? username={username}&password={password} This method returns the list of alarms sent by patients. GET api/Alarms/patient/{id}? username={username}&password={password} This method returns a certain alarm by its ID sent by patients.

Upload: others

Post on 03-Feb-2022

1 views

Category:

Documents


0 download

TRANSCRIPT

E-HEALTH SERVICE - Web API

http://ehealth-service.azurewebsites.net/Help[1/19/2013 16:53:19]

E-HEALTH SERVICE - Web API

PatientsAPI Description

GET api/Patients/Get?username={username}&password={password}

This method returns all patients of a doctor.

GET api/Patients/Get/{id}?username={username}&password={password}

This method returns detials of a single patient.

POST api/Patients/Post?username={username}&password={password}

This method adds a new patient and creates his medical record.

PUT api/Patients/Put/{id}?username={username}&password={password}

This method is used by a doctor to update patient's information.

PUT api/Patients/address/{id}?username={username}&password={password}

This method is used by a patient to update his location.

DELETE api/Patients/Delete/{id}?username={username}&password={password}

This method deletes a patient and his medical record.

POST api/Patients/email/{id}?username={username}&password={password}

This method sends an email, used by doctors.

AlarmsAPI Description

GET api/Alarms/doctorAlarms?username={username}&password={password}

This method returns the list of alarms sent by doctors.

GET api/Alarms/patientAlarms?username={username}&password={password}

This method returns the list of alarms sent by patients.

GET api/Alarms/patient/{id}?username={username}&password={password}

This method returns a certain alarm by its ID sent by patients.

E-HEALTH SERVICE - Web API

http://ehealth-service.azurewebsites.net/Help[1/19/2013 16:53:19]

POST api/Alarms/patient/{id}?username={username}&password={password}

This method is used by a patient to send alarm.

GET api/Alarms/doctor/{id}?username={username}&password={password}

This method returns a certain alarm by its ID sent by doctors.

POST api/Alarms/doctor/{id}?username={username}&password={password}

This method is used by a doctor to send an alarm.

DELETE api/Alarms/Delete/{id}?username={username}&password={password}

This method deletes an alarm.

LoginAPI Description

GET api/Login/Type?username={username}&password={password} This method is the first onecalled when a user tries to login.

GET api/Login/User?username={username}&password={password}&type={type} This is the second method calledwhen a user tries to log in.

GET api/Login/UserType?username={username}&password={password} A login method that returnsLoginResponse object

PUT api/Login/password/{id}?username={username}&currentPassword={currentPassword}&newPassword={newPassword}

A method to change passwordof a doctor

PUT api/Login/password?username={username}&password={password} This method is used to updatedoctor's, patient's or first aid'spassword.

PUT api/Login/AdminPassword?username={username}&password={password} This method is used to changeadministrator's password.

MedicalRecordsAPI Description

GET api/MedicalRecords/GetMobile/{id}?username={username}&password={password}

This method returns medical record of a patient.

GET api/MedicalRecords/Get/{id}?username={username}&password={password}

This method returns medical record of a patient.

E-HEALTH SERVICE - Web API

http://ehealth-service.azurewebsites.net/Help[1/19/2013 16:53:19]

GET api/MedicalRecords/File/{id}?fileId={fileId}&username={username}&password={password}

This method returns a medical note file

PUT api/MedicalRecords/Note/{id}?username={username}&password={password}

This method is used by a doctor to edit a medical note inpatient's medical record.

POST api/MedicalRecords/Note/{id}?username={username}&password={password}

This method is used by a doctor to add a medical note topatient's medical record.

DELETE api/MedicalRecords/Note/{id}?recid={recid}&username={username}&password={password}

This method is used by a doctor to delete a medical note inpatient's medical record.

PUT api/MedicalRecords/intervals/{id}?username={username}&password={password}

This method is used by a doctor to update patient's parameterintervals

POST api/MedicalRecords/Updates/{id}?username={username}&password={password}

This method is used by a doctor or patient to add a vitalparameter updates to patient's medical record.

DELETE api/MedicalRecords/Updates/{id}?recid={recid}&username={username}&password={password}

This method is used by a doctor to delete a vital parameterupdates in patient's medical record.

DoctorsAPI Description

GET api/Doctors/Get This method returns the list of all doctors.

GET api/Doctors/Get/{id} This method returns details of a doctor.

POST api/Doctors/Post?username={username}&password={password}

This method adds a new doctor.

PUT api/Doctors/Put/{id}?username={username}&password={password}

This method is used for updating doctor's information.

DELETE api/Doctors/Delete/{id}?username={username}&password={password}

This method deletes a doctor.

GET api/Patients/Get?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Patients-Get_username_password[1/19/2013 16:53:28]

Web API Home Page

GET api/Patients/Get?username={username}&password={password}This method returns all patients of a doctor.

Request InformationParameters

Name Description Additional information

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

GET api/Patients/Get/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Patients-Get-id_username_password[1/19/2013 16:53:31]

Web API Home Page

GET api/Patients/Get/{id}?username={username}&password={password}This method returns detials of a single patient.

Request InformationParameters

Name Description Additional information

id patient's id Define this parameter in the requestURI.

username doctor's or patient's username Define this parameter in the requestURI.

password doctor's or patient's password Define this parameter in the requestURI.

POST api/Patients/Post?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Patients-Post_username_password[1/19/2013 16:53:36]

Web API Home Page

POST api/Patients/Post?username={username}&password={password}This method adds a new patient and creates his medical record.

Request InformationParameters

Name Description Additional information

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

patient object Patient Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "Name": "sample string 1", "Surname": "sample string 2", "Doctor": { "Name": "sample string 1", "Surname": "sample string 2", "Id": 3, "Email": "sample string 4", "PhoneNumber": "sample string 5", "PublicInformation": "sample string 6", "Password": "sample string 7", "Username": "sample string 8" }, "DateOfBirth": "2013-01-19T15:53:45.2581522+00:00", "Id": 3, "HomeAddress": "sample string 4", "LastKnownAddress": "sample string 5", "Email": "sample string 6", "PhoneNumner": "sample string 7", "IdentityNumber": "sample string 8", "MandatoryVitalParameters": { "DiastolicPressure": true, "SystolicPressure": true, "HeartRate": true, "RespiratoryRate": true, "OxygenSaturation": true, "Sugar": true, "Temperature": true }, "Password": "sample string 9", "Username": "sample string 10"

POST api/Patients/Post?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Patients-Post_username_password[1/19/2013 16:53:36]

}

application/x-www-form-urlencoded

Sample:

Sample not available.

PUT api/Patients/Put/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-Patients-Put-id_username_password[1/19/2013 16:53:38]

Web API Home Page

PUT api/Patients/Put/{id}?username={username}&password={password}This method is used by a doctor to update patient's information.

Request InformationParameters

Name Description Additional information

id patient's id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

patient object Patient Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "Name": "sample string 1", "Surname": "sample string 2", "Doctor": { "Name": "sample string 1", "Surname": "sample string 2", "Id": 3, "Email": "sample string 4", "PhoneNumber": "sample string 5", "PublicInformation": "sample string 6", "Password": "sample string 7", "Username": "sample string 8" }, "DateOfBirth": "2013-01-19T15:53:49.8379473+00:00", "Id": 3, "HomeAddress": "sample string 4", "LastKnownAddress": "sample string 5", "Email": "sample string 6", "PhoneNumner": "sample string 7", "IdentityNumber": "sample string 8", "MandatoryVitalParameters": { "DiastolicPressure": true, "SystolicPressure": true, "HeartRate": true,

PUT api/Patients/Put/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-Patients-Put-id_username_password[1/19/2013 16:53:38]

"RespiratoryRate": true, "OxygenSaturation": true, "Sugar": true, "Temperature": true }, "Password": "sample string 9", "Username": "sample string 10"}

application/x-www-form-urlencoded

Sample:

Sample not available.

PUT api/Patients/address/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-Patients-address-id_username_password[1/19/2013 16:53:41]

Web API Home Page

PUT api/Patients/address/{id}?username={username}&password={password}This method is used by a patient to update his location.

Request InformationParameters

Name Description Additional information

id patient's id Define this parameter in the requestURI.

username patient's username Define this parameter in the requestURI.

password patient's password Define this parameter in the requestURI.

address patient's new location Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:"sample string 1"

application/x-www-form-urlencoded

Sample:

Sample not available.

DELETE api/Patients/Delete/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/DELETE-api-Patients-Delete-id_username_password[1/19/2013 16:53:44]

Web API Home Page

DELETE api/Patients/Delete/{id}?username={username}&password={password}This method deletes a patient and his medical record.

Request InformationParameters

Name Description Additional information

id patient's id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

POST api/Patients/email/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Patients-email-id_username_password[1/19/2013 16:53:46]

Web API Home Page

POST api/Patients/email/{id}?username={username}&password={password}This method sends an email, used by doctors.

Request InformationParameters

Name Description Additional information

id doctor's id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

patientRecipient No documentation available. Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "Name": "sample string 1", "Surname": "sample string 2", "Doctor": { "Name": "sample string 1", "Surname": "sample string 2", "Id": 3, "Email": "sample string 4", "PhoneNumber": "sample string 5", "PublicInformation": "sample string 6", "Password": "sample string 7", "Username": "sample string 8" }, "DateOfBirth": "2013-01-19T15:53:58.1534797+00:00", "Id": 3, "HomeAddress": "sample string 4", "LastKnownAddress": "sample string 5", "Email": "sample string 6", "PhoneNumner": "sample string 7", "IdentityNumber": "sample string 8", "MandatoryVitalParameters": { "DiastolicPressure": true, "SystolicPressure": true, "HeartRate": true,

POST api/Patients/email/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Patients-email-id_username_password[1/19/2013 16:53:46]

"RespiratoryRate": true, "OxygenSaturation": true, "Sugar": true, "Temperature": true }, "Password": "sample string 9", "Username": "sample string 10"}

application/x-www-form-urlencoded

Sample:

Sample not available.

GET api/Alarms/doctorAlarms?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Alarms-doctorAlarms_username_password[1/19/2013 16:53:49]

Web API Home Page

GET api/Alarms/doctorAlarms?username={username}&password={password}This method returns the list of alarms sent by doctors.

Request InformationParameters

Name Description Additional information

username first aid username Define this parameter in the requestURI.

password first aid password Define this parameter in the requestURI.

GET api/Alarms/patientAlarms?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Alarms-patientAlarms_username_password[1/19/2013 16:53:53]

Web API Home Page

GET api/Alarms/patientAlarms?username={username}&password={password}This method returns the list of alarms sent by patients.

Request InformationParameters

Name Description Additional information

username first aid username Define this parameter in the requestURI.

password first aid password Define this parameter in the requestURI.

GET api/Alarms/patient/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Alarms-patient-id_username_password[1/19/2013 16:53:54]

Web API Home Page

GET api/Alarms/patient/{id}?username={username}&password={password}This method returns a certain alarm by its ID sent by patients.

Request InformationParameters

Name Description Additional information

id alarm id Define this parameter in the requestURI.

username first aid username Define this parameter in the requestURI.

password first aid password Define this parameter in the requestURI.

POST api/Alarms/patient/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Alarms-patient-id_username_password[1/19/2013 16:53:57]

Web API Home Page

POST api/Alarms/patient/{id}?username={username}&password={password}This method is used by a patient to send alarm.

Request InformationParameters

Name Description Additional information

id patient's id Define this parameter in the requestURI.

username patient's username Define this parameter in the requestURI.

password patient's password Define this parameter in the requestURI.

alarm object PatientAlarm Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "GPSLocation": { "X": 1.1, "Y": 2.1 }, "Patient": { "Name": "sample string 1", "Surname": "sample string 2", "Doctor": { "Name": "sample string 1", "Surname": "sample string 2", "Id": 3, "Email": "sample string 4", "PhoneNumber": "sample string 5", "PublicInformation": "sample string 6", "Password": "sample string 7", "Username": "sample string 8" }, "DateOfBirth": "2013-01-19T15:54:08.7042022+00:00", "Id": 3, "HomeAddress": "sample string 4", "LastKnownAddress": "sample string 5", "Email": "sample string 6", "PhoneNumner": "sample string 7",

POST api/Alarms/patient/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Alarms-patient-id_username_password[1/19/2013 16:53:57]

"IdentityNumber": "sample string 8", "MandatoryVitalParameters": { "DiastolicPressure": true, "SystolicPressure": true, "HeartRate": true, "RespiratoryRate": true, "OxygenSaturation": true, "Sugar": true, "Temperature": true }, "Password": "sample string 9", "Username": "sample string 10" }, "TimeReceived": "2013-01-19T15:54:08.7042022+00:00", "Id": 1, "Read": true}

application/x-www-form-urlencoded

Sample:

Sample not available.

GET api/Alarms/doctor/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Alarms-doctor-id_username_password[1/19/2013 16:54:00]

Web API Home Page

GET api/Alarms/doctor/{id}?username={username}&password={password}This method returns a certain alarm by its ID sent by doctors.

Request InformationParameters

Name Description Additional information

id alarm id Define this parameter in the requestURI.

username first aid username Define this parameter in the requestURI.

password first aid password Define this parameter in the requestURI.

POST api/Alarms/doctor/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Alarms-doctor-id_username_password[1/19/2013 16:54:03]

Web API Home Page

POST api/Alarms/doctor/{id}?username={username}&password={password}This method is used by a doctor to send an alarm.

Request InformationParameters

Name Description Additional information

id patient's id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

alarm object DoctorAlarm Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "AlarmLevel": 0, "Diagnosis": "sample string 1", "Patient": { "Name": "sample string 1", "Surname": "sample string 2", "Doctor": { "Name": "sample string 1", "Surname": "sample string 2", "Id": 3, "Email": "sample string 4", "PhoneNumber": "sample string 5", "PublicInformation": "sample string 6", "Password": "sample string 7", "Username": "sample string 8" }, "DateOfBirth": "2013-01-19T15:54:14.081163+00:00", "Id": 3, "HomeAddress": "sample string 4", "LastKnownAddress": "sample string 5", "Email": "sample string 6", "PhoneNumner": "sample string 7", "IdentityNumber": "sample string 8", "MandatoryVitalParameters": {

POST api/Alarms/doctor/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Alarms-doctor-id_username_password[1/19/2013 16:54:03]

"DiastolicPressure": true, "SystolicPressure": true, "HeartRate": true, "RespiratoryRate": true, "OxygenSaturation": true, "Sugar": true, "Temperature": true }, "Password": "sample string 9", "Username": "sample string 10" }, "TimeReceived": "2013-01-19T15:54:14.081163+00:00", "Id": 2, "Read": true}

application/x-www-form-urlencoded

Sample:

Sample not available.

DELETE api/Alarms/Delete/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/DELETE-api-Alarms-Delete-id_username_password[1/19/2013 16:54:06]

Web API Home Page

DELETE api/Alarms/Delete/{id}?username={username}&password={password}This method deletes an alarm.

Request InformationParameters

Name Description Additional information

id alarm id Define this parameter in the requestURI.

username first aid username Define this parameter in the requestURI.

password first aid password Define this parameter in the requestURI.

GET api/Login/Type?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Login-Type_username_password[1/19/2013 16:54:08]

Web API Home Page

GET api/Login/Type?username={username}&password={password}This method is the first one called when a user tries to log in.

Request InformationParameters

Name Description Additional information

username user's username Define this parameter in the requestURI.

password user's password Define this parameter in the requestURI.

GET api/Login/User?username={username}&password={password}&type={type}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Login-User_username_password_type[1/19/2013 16:54:12]

Web API Home Page

GET api/Login/User?username={username}&password={password}&type={type}This is the second method called when a user tries to log in.

Request InformationParameters

Name Description Additional information

username user's username Define this parameter in the requestURI.

password user's password Define this parameter in the requestURI.

type type of user Define this parameter in the requestURI.

GET api/Login/UserType?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Login-UserType_username_password[1/19/2013 16:54:14]

Web API Home Page

GET api/Login/UserType?username={username}&password={password}A login method that returns LoginResponse object

Request InformationParameters

Name Description Additional information

username user's username Define this parameter in the requestURI.

password user's password Define this parameter in the requestURI.

PUT api/Login/password/{id}?username={username}&currentPassword={currentPassword}&newPassword={newPassword}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-Login-password-id_username_currentPassword_newPassword[1/19/2013 16:54:17]

Web API Home Page

PUT api/Login/password/{id}?username={username}&currentPassword={currentPassword}&newPassword={newPassword}A method to change password of a doctor

Request InformationParameters

Name Description Additional information

id Doctor's id Define this parameter in the request URI.

username Doctor's username Define this parameter in the request URI.

currentPassword Doctor's current password Define this parameter in the request URI.

newPassword Doctor's new password Define this parameter in the request URI.

PUT api/Login/password?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-Login-password_username_password[1/19/2013 16:54:20]

Web API Home Page

PUT api/Login/password?username={username}&password={password}This method is used to update doctor's, patient's or first aid's password.

Request InformationParameters

Name Description Additional information

username username of person changing the password Define this parameter in the requestURI.

password current password Define this parameter in the requestURI.

newPassword new password Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:"sample string 1"

application/x-www-form-urlencoded

Sample:

Sample not available.

PUT api/Login/AdminPassword?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-Login-AdminPassword_username_password[1/19/2013 16:54:24]

Web API Home Page

PUT api/Login/AdminPassword?username={username}&password={password}This method is used to change administrator's password.

Request InformationParameters

Name Description Additional information

username administrator's password Define this parameter in the requestURI.

password administrator's current password Define this parameter in the requestURI.

newPassword administrator's new password Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:"sample string 1"

application/x-www-form-urlencoded

Sample:

Sample not available.

GET api/MedicalRecords/GetMobile/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-MedicalRecords-GetMobile-id_username_password[1/19/2013 16:54:31]

Web API Home Page

GET api/MedicalRecords/GetMobile/{id}?username={username}&password={password}This method returns medical record of a patient.

Request InformationParameters

Name Description Additional information

id patient's id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

GET api/MedicalRecords/Get/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-MedicalRecords-Get-id_username_password[1/19/2013 16:54:34]

Web API Home Page

GET api/MedicalRecords/Get/{id}?username={username}&password={password}This method returns medical record of a patient.

Request InformationParameters

Name Description Additional information

id patient's id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

GET api/MedicalRecords/File/{id}?fileId={fileId}&username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-MedicalRecords-File-id_fileId_username_password[1/19/2013 16:54:38]

Web API Home Page

GET api/MedicalRecords/File/{id}?fileId={fileId}&username={username}&password={password}This method returns a medical note file

Request InformationParameters

Name Description Additional information

id patient's id Define this parameter in the requestURI.

fileId file's id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

PUT api/MedicalRecords/Note/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-MedicalRecords-Note-id_username_password[1/19/2013 16:54:40]

Web API Home Page

PUT api/MedicalRecords/Note/{id}?username={username}&password={password}This method is used by a doctor to edit a medical note in patient's medical record.

Request InformationParameters

Name Description Additional information

id patient's medical record id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

medicalNote object MedicalNote Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "Id": 1, "DateTime": "2013-01-19T15:54:51.985335+00:00", "Note": "sample string 3", "Image": { "Id": 1, "Bytes": "QEBA", "Filename": "sample string 2" }}

application/x-www-form-urlencoded

Sample:

PUT api/MedicalRecords/Note/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-MedicalRecords-Note-id_username_password[1/19/2013 16:54:40]

Sample not available.

POST api/MedicalRecords/Note/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-MedicalRecords-Note-id_username_password[1/19/2013 16:54:43]

Web API Home Page

POST api/MedicalRecords/Note/{id}?username={username}&password={password}This method is used by a doctor to add a medical note to patient's medical record.

Request InformationParameters

Name Description Additional information

id patient's medical record id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

medicalNote object MedicalNote Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "Id": 1, "DateTime": "2013-01-19T15:54:54.361171+00:00", "Note": "sample string 3", "Image": { "Id": 1, "Bytes": "QEBA", "Filename": "sample string 2" }}

application/x-www-form-urlencoded

Sample:

POST api/MedicalRecords/Note/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-MedicalRecords-Note-id_username_password[1/19/2013 16:54:43]

Sample not available.

DELETE api/MedicalRecords/Note/{id}?recid={recid}&username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/DELETE-api-MedicalRecords-Note-id_recid_username_password[1/19/2013 16:54:45]

Web API Home Page

DELETE api/MedicalRecords/Note/{id}?recid={recid}&username={username}&password={password}This method is used by a doctor to delete a medical note in patient's medical record.

Request InformationParameters

Name Description Additional information

id note's id Define this parameter in the requestURI.

recid patient's medical record id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

PUT api/MedicalRecords/intervals/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-MedicalRecords-intervals-id_username_password[1/19/2013 16:54:47]

Web API Home Page

PUT api/MedicalRecords/intervals/{id}?username={username}&password={password}This method is used by a doctor to update patient's parameter intervals

Request InformationParameters

Name Description Additional information

id record id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

intervals Intervals object Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "SystolicLowerLimit": 1.1, "DiastolicLowerLimit": 2.1, "BloodSugarLevelLowerLimit": 3.1, "HeartRateLowerLimit": 4.1, "RespiratoryLowerLimit": 5.1, "OxygenSaturationLowerLimit": 6.1, "TemperatureLowerLimit": 7.1, "SystolicUpperLimit": 8.1, "DiastolicUpperLimit": 9.1, "BloodSugarLevelUpperLimit": 10.1, "HeartRateUpperLimit": 11.1, "RespiratoryUpperLimit": 12.1, "OxygenSaturationUpperLimit": 13.1, "TemperatureUpperLimit": 14.1}

application/x-www-form-urlencoded

PUT api/MedicalRecords/intervals/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-MedicalRecords-intervals-id_username_password[1/19/2013 16:54:47]

Sample:

Sample not available.

POST api/MedicalRecords/Updates/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-MedicalRecords-Updates-id_username_password[1/19/2013 16:54:50]

Web API Home Page

POST api/MedicalRecords/Updates/{id}?username={username}&password={password}This method is used by a doctor or patient to add a vital parameter updates to patient's medical record.

Request InformationParameters

Name Description Additional information

id patient's medical record id Define this parameter in the requestURI.

username doctor's or patient's username Define this parameter in the requestURI.

password doctor's or patient's password Define this parameter in the requestURI.

parametersUpdate object VitalParameterUpdate Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "Id": 1, "DateTime": "2013-01-19T15:55:01.83255+00:00", "VitalParameterMeasurements": [ { "Id": 1, "VitalParameter": 0, "Value": 2.1 }, { "Id": 1, "VitalParameter": 0, "Value": 2.1 }, { "Id": 1, "VitalParameter": 0, "Value": 2.1 } ]}

POST api/MedicalRecords/Updates/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-MedicalRecords-Updates-id_username_password[1/19/2013 16:54:50]

application/x-www-form-urlencoded

Sample:

Sample not available.

DELETE api/MedicalRecords/Updates/{id}?recid={recid}&username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/DELETE-api-MedicalRecords-Updates-id_recid_username_password[1/19/2013 16:54:52]

Web API Home Page

DELETE api/MedicalRecords/Updates/{id}?recid={recid}&username={username}&password={password}This method is used by a doctor to delete a vital parameter updates in patient's medical record.

Request InformationParameters

Name Description Additional information

id VitalParametersUpdate's id Define this parameter in the requestURI.

recid patient's medical record id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

GET api/Doctors/Get

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Doctors-Get[1/19/2013 16:54:54]

Web API Home Page

GET api/Doctors/GetThis method returns the list of all doctors.

GET api/Doctors/Get/{id}

http://ehealth-service.azurewebsites.net/Help/Api/GET-api-Doctors-Get-id[1/19/2013 16:54:56]

Web API Home Page

GET api/Doctors/Get/{id}This method returns details of a doctor.

Request InformationParameters

Name Description Additional information

id doctor's id Define this parameter in the requestURI.

POST api/Doctors/Post?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Doctors-Post_username_password[1/19/2013 16:54:59]

Web API Home Page

POST api/Doctors/Post?username={username}&password={password}This method adds a new doctor.

Request InformationParameters

Name Description Additional information

username administrator's username Define this parameter in the requestURI.

password administrator's password Define this parameter in the requestURI.

doctor object Doctor Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "Name": "sample string 1", "Surname": "sample string 2", "Id": 3, "Email": "sample string 4", "PhoneNumber": "sample string 5", "PublicInformation": "sample string 6", "Password": "sample string 7", "Username": "sample string 8"}

application/x-www-form-urlencoded

Sample:

Sample not available.

POST api/Doctors/Post?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/POST-api-Doctors-Post_username_password[1/19/2013 16:54:59]

PUT api/Doctors/Put/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-Doctors-Put-id_username_password[1/19/2013 16:55:02]

Web API Home Page

PUT api/Doctors/Put/{id}?username={username}&password={password}This method is used for updating doctor's information.

Request InformationParameters

Name Description Additional information

id doctor's id Define this parameter in the requestURI.

username doctor's username Define this parameter in the requestURI.

password doctor's password Define this parameter in the requestURI.

doctor object Doctor Define this parameter in the requestbody.

Request body formats

application/json, text/json

Sample:{ "Name": "sample string 1", "Surname": "sample string 2", "Id": 3, "Email": "sample string 4", "PhoneNumber": "sample string 5", "PublicInformation": "sample string 6", "Password": "sample string 7", "Username": "sample string 8"}

application/x-www-form-urlencoded

Sample:

PUT api/Doctors/Put/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/PUT-api-Doctors-Put-id_username_password[1/19/2013 16:55:02]

Sample not available.

DELETE api/Doctors/Delete/{id}?username={username}&password={password}

http://ehealth-service.azurewebsites.net/Help/Api/DELETE-api-Doctors-Delete-id_username_password[1/19/2013 16:55:05]

Web API Home Page

DELETE api/Doctors/Delete/{id}?username={username}&password={password}This method deletes a doctor.

Request InformationParameters

Name Description Additional information

id doctor's id Define this parameter in the requestURI.

username administrator's username Define this parameter in the requestURI.

password administrator's password Define this parameter in the requestURI.