WebDoctors Plus Member Management API
Version: 1.0.2

API documentation for the WebDoctors Plus member platform. All methods described are related to Member Management.

API Endpoint URLs:
All DEV API endpoints begin with: 
https://www.webdoctorsplus.com/dev/go/api/
All PROD API endpoints begin with:
https://portal.webdoctorsplus.com/dev/go/api/

API Authorization

The WebDoctors Plus platform implements  JSON Web Tokens (JWT)  for API authorization.
How it works:
  1. Make an api call to /login using the members email and password
  2. Upon successful login, you will receive a response like {"success":true}
  3. The response will be accompanied by an HTTP Header named "Authorization"
  4. The Authorization Header will contain the JWT in the form "Bearer XXXX.XXXX.XXXX"
  5. You MUST supply this same header with each api request after login
                   - Without that header, the member will receive authorization errors
                   -You may securely store the header information on your end to re-use for each request
                   -The tokens will expire after 24 hours of non-use
                                      -If the token expires you will receive this response: {"success":false,"message":"Token Expired","type":"mt:authorization"}
                                      -If the token is expired you will need to make another call to /api/login to get a new token

Default response content-types: application/json
Schemes: https



Summary

Tag: Single Sign-on

Operation

Description

POST /sso/createAccessToken

Create SSO Access Token

Tag: Manage Member EMR

Operation

Description

GET /healthRecords/{userId}

Gets a member's EMR record by userId - usually used to retrieve dependents

GET /healthRecords

Retrieves member's EMR record

POST /healthRecords/healthRecordsFromPayload

Updates a member's EMR record

Tag: Logout

Operation

Description

GET /logout

Logout

Tag: Consultation History

Operation

Description

GET /consultationHistory/all

Retrieves Members Consultations

Tag: Get Timezones

Operation

Description

GET /timezones/all

Retrieves all timezones with their IDs

Tag: Manage Member Medication Allergies

Operation

Description

POST /medicationAllergies/update/{userId}

Retrieves all timezones with their IDs

Tag: Manage Member Attachments

Operation

Description

GET /attachment/delete/{attachmentId}/{userId}

Retrieves all timezones with their IDs

POST /attachment/add/{userId}

Retrieves all timezones with their IDs

GET /attachment/stream/{attachmentId}/{streamMethod}/{userId}

Retrieves all timezones with their IDs

POST /attachment/addAskADoctorAttachment

Attach a document to an Ask A Doctor Request

Tag: Ask A Doctor Requests

Operation

Description

GET /askADoctor/endConversation/{askADoctorMessageId}

Closes an Ask a Doctor request

POST /askADoctor/add

Create a message for an Ask A Doctor Request

GET /askADoctor/thread/{askADoctorThreadId}

Retrieves Ask A Doctor Request Thread

GET /askADoctor/{page}

Retrieves top-level Ask A Doctor Requests for a Member

Tag: Login

Operation

Description

POST /login

Login

Tag: Get States

Operation

Description

GET /states/all

Retrieves all states with their IDs

GET /states/rules/{stateAbbreviation}

Retrieves consultation rules for an individual state or all.

Tag: Manage User Notification Settings

Operation

Description

POST /notificationSettings

Update Notification Settings

Tag: Manage Member Medications

Operation

Description

POST /medication/update/{medicationId}/{userId}

Update a medication

POST /medication/add/{userId}

Create a medication

GET /medication/delete/{medicationId}/{userId}

Delete a medication

Tag: Manage Member Account

Operation

Description

POST /memberAccount/resendDependentEmail

Re-send registration email to member

Retrieves dependent relationship type

GET /memberAccount/relationshipType

GET /memberAccount/status

Retrieves member status types

Retrieves a members dependent

GET /memberAccount/get/dependent/{dependentUserId}

Update a dependents email when over 18 years old

POST /memberAccount/updateDependentEmail

Update a dependent

POST /memberAccount/updateDependent

Create a dependent

POST /memberAccount/addDependent

Update a member password

POST /memberAccount/updatePassword

Updates a members contact information

POST /memberAccount/updateMemberContactInfo

Get Member Pharmacy

GET /memberAccount/getPharmacy/{userId}

Retrieves account information for a member

GET /memberAccount

Tag: Manage Member Personal Details

Operation

Description

POST /personal/update/{userId}

Update member personal details

Tag: Get Diagnostic Phone Consultation Status

Operation

Description

GET /consultation/status/{consultationId}

Get consultation status

Tag: Get Diagnostic Video Consultation Status

Operation

Description

GET /consultation/status/{consultationId}

Get consultation status

Tag: Get Informational Phone Consultation Status

Operation

Description

GET /consultation/status/{consultationId}

Get consultation status

Tag: Get Current Active Consultations

Operation

Description

GET /consultation/getActive

Get Active Consultations and their statuses

Tag: Manage Diagnostic Consultation From Payload

Operation

Description

GET /consultation/diagnostic/memberCancel/{userId}/{consultationId}

Cancel diagnostic consultation - member

POST /consultation/diagnosticFromMemberPayload

Diagnostic Consultation by Phone or Video - From Member Payload

GET /consultation/diagnostic/cancel/{userId}/{consultationId}

Cancel diagnostic consultation - groupAdmin

Tag: Manage Member Medical Conditions

Operation

Description

POST /medicalCondition/update/{medicalConditionId}/{userId}

Update a medication

GET /medicalCondition/delete/{medicalConditionId}/{userId}

Create a medication

POST /medicalCondition/add/{userId}

Create a medical condition

Tag: Rate Consultation Visit

Operation

Description

POST /consultation/fiveStarRating

Add 5 star rating to consult

Tag: Manage Informational Phone Consultation

Operation

Description

GET /consultation/informational/phone/start

Informational By Phone - Start the workflow

Start Consultation

GET /consultation/start/{consultType}

GET /consultation/completeConsultation

Complete Informational Consultation

Informational By Phone - update consultation fields

POST /consultation/updateConsultation

Informational By Phone - Get All Data Necessary

GET /consultation/informational/phone/all/{userId}

Cancel Consultation

GET /consultation/cancel

Tag: Census Management

Operation

Description

POST /census/createMemberDependent

Create a dependent

Update Member

POST /census/updateMember

POST /census/createMember

Create New Member

Re-enrolls previously disenrolled member

GET /census/enrollMember/{userId}

Update a dependent

POST /census/updateMemberDependent

Create new group

POST /census/createSubGroup

Disenroll member

GET /census/disenrollMember/{userId}

Tag: Manage Diagnostic Phone Consultation

Operation

Description

GET /consultation/start/{consultType}

Start Consultation

POST /consultation/diagnostic/phone/step-9/payment/{userId}

Diagnostic By Phone - Step 9 with payment

GET /consultation/cancel

Cancel Consultation

Tag: Manage Diagnostic Video Consultation

Operation

Description

GET /consultation/start/{consultType}

Start Consultation