ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

MyAirCoach

API	Description
POST api/v1/myaircoach/observation/cloud	Post an observations
POST api/v1/myaircoach/environmental	Post an observations
POST api/v1/myaircoach/user	Register a new user
GET api/v1/myaircoach/user/{userId}	Retrieve the user
PUT api/v1/myaircoach/user/{userId}	Update the user
PUT api/v1/myaircoach/user/{userId}/password	Update the password for the user
DELETE api/v1/myaircoach/user/{userId}	Delete the user
POST api/v1/myaircoach/user/{userId}/device	Register a new device for a specific user
GET api/v1/myaircoach/user/{userId}/device/{equipmentId}	Retrieve a specific device for a user
GET api/v1/myaircoach/user/{userId}/device	Retrieve a specific device for a user
PUT api/v1/myaircoach/user/{userId}/device/{equipmentId}	Update a specific device for a user
DELETE api/v1/myaircoach/user/{userId}/device/{equipmentId}	Retrieve a specific device for a user
GET api/v1/myaircoach/user/{userId}/fitbit/authorize	Authorize a shim to a patient
GET api/v1/myaircoach/user/{userId}/fitbit/status	Retrieve the FitBit status
DELETE api/v1/myaircoach/user/{userId}/fitbit/deauthorize	Retrieve the FitBit status
GET api/v1/myaircoach/login	Login the user with basic auth. authorization
GET api/MyAirCoach	No documentation available.

Patient

Controller for single patient identified by token header

API	Description
POST api/v1/patient/update	Updates the specified patient identified by token header
GET api/v1/patient	Gets the patient identified by token header
GET api/v1/patient/height	Gets the height of the patient identified by token header
GET api/v1/patient/age	Gets the age of the patient identified by token header
POST api/v1/patient/times/store	Set the patient times
GET api/v1/patient/times/get	Gets the patient times identified by token header
POST api/v1/patient/reminders/store	Turn on/off reminders for patient
GET api/v1/patient/reminders/get	Gets the patient times identified by token header
GET api/v1/patient/devices?DeviceTypeId={DeviceTypeId}&Id={Id}&Status={Status}	Gets the devices based on the query
POST api/v1/patient/device/create	Creates a new device
POST api/v1/patient/device/update	Updates the information about the device

Admin

API	Description
POST api/v1/administrator/healthprofessional/create	Todo: Update with correct information. Need userAccountId!
GET api/v1/administrator/healthprofessionals	Todo: Update with correct information
GET api/v1/administrator/healthprofessional/{id}	Todo: Update with correct information
GET api/v1/administrator/user/{userAccountId}/username	Gets the username from the user account identifier for the health professional
POST api/v1/administrator/healthprofessional/update	Todo: Update with correct information
DELETE api/v1/administrator/healthprofessional/delete/{id}	Todo: Update with correct information

Authentication

Controls the authentication for users

API	Description
POST api/v1/authentication/login	Logins the specified user.
POST api/v1/authentication/logout	Logouts the user based on token header.
GET api/v1/authentication/ping	Ping the server to see if the token are alive.

ThirdPartyAPI

API	Description
GET api/v1/thirdpartyapi/registry	List all registred shims enabled and their scopes.
GET api/v1/thirdpartyapi/authorize/{shim}?patientId={patientId}	Authorize a shim to a patient
DELETE api/v1/thirdpartyapi/de-authorize/{shim}?patientId={patientId}	De-authorize a shim to a patient
POST api/v1/thirdpartyapi/authorize/{shim}/callback	No documentation available.
GET api/v1/thirdpartyapi/authorize/{shim}/callback	No documentation available.
GET api/v1/thirdpartyapi/authorize/{shim}/callback/authorizationComplete/success	No documentation available.
GET api/v1/thirdpartyapi/authorize/{shim}/callback/authorizationComplete/failure	No documentation available.
GET api/v1/thirdpartyapi/data/{shim}/{endpoint}?patientId={patientId}&date={date}	Get data from a shim and respective endpoint for a patient and date
GET api/v1/thirdpartyapi/call/{shim}/{endpoint}?patientId={patientId}&startDate={startDate}&endDate={endDate}	Get data from a shim and respective endpoint for a patient and date
POST api/v1/thirdpartyapi/subscriber/{shim}/notification?updates={updates}&verify={verify}	Subscriber callback for notification. Verifies the subscriber and handles new notifications.
GET api/v1/thirdpartyapi/subscriber/{shim}/notification?updates={updates}&verify={verify}	Subscriber callback for notification. Verifies the subscriber and handles new notifications.
GET api/v1/thirdpartyapi/subscription?subId={subId}	No documentation available.

Questionnaire

API	Description
POST api/v1/questionnaire/send	Stores the questionnaire meta data and answers
GET api/v1/questionnaire/get?qid={qid}&date={date}&timingEvent={timingEvent}&offset={offset}	Retrive a questionnaire meta data and answers. Filtering based on the query parameters.
GET api/v1/questionnaire/value/{questionnaireId}/period?value={value}&type={type}&offset={offset}	Retrive a collection of questionnaires over a period.
GET api/v1/questionnaire/get/patient?PatientId={PatientId}&Qid={Qid}&Date={Date}&TimingEvent={TimingEvent}&Offset={Offset}	Get questionnaire answers based on date

HealthProfessional

API	Description
GET api/v1/healthprofessional	Gets the health professional identified by token header
POST api/v1/healthprofessional/update	Updates the information about the health profesional
GET api/v1/healthprofessional/devices?PatientId={PatientId}&DeviceTypeId={DeviceTypeId}&Id={Id}&Status={Status}	Gets a collection of devices, filtered with the query.
POST api/v1/healthprofessional/device/create	Creates a new device
POST api/v1/healthprofessional/device/update	Updates the information about the device
GET api/v1/healthprofessional/device/gethistory?PatientId={PatientId}&Action={Action}&EUI64={EUI64}&StartTime={StartTime}&EndTime={EndTime}&Order={Order}	Gets list of the device history filtered by the query.
GET api/v1/healthprofessional/patient/{patientId}/observation/{operation}/{typeId}/period?Value={Value}&Type={Type}&GroupedBy={GroupedBy}&Order={Order}&Offset={Offset}	Gets a collection of observations based on query for a period
GET api/v1/healthprofessional/patient/{patientId}/observation/{operation}/{typeId}/between?StartTime={StartTime}&EndTime={EndTime}&Order={Order}&Offset={Offset}	Gets a collection of observations based on query between two timestamps
DELETE api/v1/healthprofessional/patient/{patientId}/observation/delete/{rawobservationid}	Deletes the observation based on raw observation id.
POST api/v1/healthprofessional/patient/{patientId}/observation/update	Deletes the observation based on raw observation id.
GET api/v1/healthprofessional/patients	Gets the patient list for this health professional
GET api/v1/healthprofessional/patient/{patientId}	Gets the information for a specific patient based on patient identifier in the url
GET api/v1/healthprofessional/patient/user/{userAccountId}/username	No documentation available.
POST api/v1/healthprofessional/patient/create	Creates a new patient
POST api/v1/healthprofessional/patient/update	Updates the information of the patient
POST api/v1/healthprofessional/patient/{patientId}/times/store	Set the patient times
GET api/v1/healthprofessional/patient/{patientId}/times/get	Gets the patient times identified by token header
POST api/HealthProfessional?patientId={patientId}	No documentation available.

Development

API	Description
GET api/v1/development/observation/overview/{patientId}?Offset={Offset}	Gets the latest observations for each device type
DELETE api/v1/development/observation/{rawobservationid}	No documentation available.
GET api/v1/development/healthprofessional/overview/{healthprofessionalid}?Offset={Offset}	No documentation available.
POST api/v1/development/overridepassword	No documentation available.
DELETE api/v1/development/token/{dateTime}	Deletes older tokens
GET api/v1/development/questionnaire/{patientId}?offset={offset}	No documentation available.
GET api/v1/development/{patientId}/observation/{operation}/{typeId}/between?startTime={startTime}&endTime={endTime}&order={order}&offset={offset}&groupedBy={groupedBy}	No documentation available.
POST api/v1/development/user/create	Creates a user account from the specified user information.
GET api/v1/development/{operation}/{typeId}/period?value={value}&type={type}&groupedBy={groupedBy}&order={order}&offset={offset}&patientId={patientId}	Gets a collection of observations based on query for a period

UserAccount

API	Description
POST api/v1/user/create	Creates a user account from the specified user information.
POST api/v1/user/update	Updates the specified user account.
GET api/v1/user/permission	Gets the permission for the user, use Token in header.
GET api/v1/user/id	Gets the user identifier from token in header.
GET api/v1/user/{userAccountId}/username	Gets the username of the user account identifier
DELETE api/v1/user/delete/{id}	No documentation available.
POST api/v1/user/password/recovery	Passwords the recovery.
POST api/v1/user/password/update	Updates the password.
POST api/v1/user/password/verification	Verify email and set a new password

Observation

Overall handle for observations

API	Description
POST api/v1/observation	Post a collection of observations
POST api/v1/observation/CommunicatePCDData	Communicates the PCD data.
POST api/v1/observation/cloud	Post an observations
GET api/v1/observation/{operation}/{typeId}/period?value={value}&type={type}&groupedBy={groupedBy}&order={order}&offset={offset}	Gets a collection of observations based on query for a period
GET api/v1/observation/{operation}/{typeId}/between?startTime={startTime}&endTime={endTime}&order={order}&offset={offset}&groupedBy={groupedBy}	Gets a collection of observations based on query between two timestamps
GET api/v1/observation/value/{typeId}/taken?Value={Value}&Order={Order}&Offset={Offset}	Gets a collection of observations based on query for a period
GET api/v1/observation/overview?Offset={Offset}	Gets the latest observations for each device type
DELETE api/v1/observation/delete/{rawobservationid}	Deletes the observation based on raw observation id.
POST api/v1/observation/update	Updates the observation.

Measurement

API	Description
GET api/v1/measurement/{operation}/{typeId}/period?Value={Value}&Type={Type}&GroupedBy={GroupedBy}&Order={Order}&Offset={Offset}	Gets a collection of measurements based on query for a period
GET api/v1/measurement/{operation}/{typeId}/between?StartTime={StartTime}&EndTime={EndTime}&Order={Order}&Offset={Offset}	Gets a collection of measurements based on query between two timestamps
GET api/v1/measurement/{operation}/{typeId}/taken?taken={taken}&order={order}&offset={offset}	Gets a collection of measurements based on query between two timestamps

CAMI

API	Description
POST api/v1/cami/authentication/login	Logins the specified user.
POST api/v1/cami/authentication/logout	Logouts the user based on token header. <p>HEADER: Token</p>
GET api/v1/cami/authentication/ping	Ping the server to see if the token are alive.
GET api/v1/cami/observation/{operation}/{typeId}/period?value={value}&type={type}&groupedBy={groupedBy}&order={order}&offset={offset}	Gets a collection of observations based on query for a period
GET api/v1/cami/measurement/{operation}/{typeId}/period?Value={Value}&Type={Type}&GroupedBy={GroupedBy}&Order={Order}&Offset={Offset}	Gets a collection of measurements based on query for a period
GET api/v1/cami/observation/value/{typeId}/between?startTime={startTime}&endTime={endTime}&order={order}&offset={offset}&groupedBy={groupedBy}	Gets a collection of observations based on query between two timestamps
GET api/v1/cami/patient	Gets the patient identified by token header
GET api/v1/cami/activity?user={user}&order_by={order_by}	Gets the patient identified by token header
GET api/v1/cami/journal_entries?user={user}	Gets the patient identified by token header
POST api/v1/cami/journal_entires/{entryId}/acknowledge?status={status}	Gets the patient identified by token header
GET api/v1/cami/dashboard?offset={offset}	No documentation available.

Dashboard

Overall handle for dashboard

API	Description
GET api/v1/dashboard?offset={offset}	Gets the latest observations for each device type