ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Account

API	Description
GET api/Account/GetEhrAuthorizationToken	No documentation available.
POST api/Account/ConfirmAccount	Confirms the account.
POST api/Account/Login	No documentation available.
GET api/Account/IsAuthorized	No documentation available.
GET api/Account/GetHomeData	Gets the home data screen.
GET api/Account/GetMonthlyPatientStatus	Gets the latest 6 month comparison between the new or repeat patient
GET api/Account/GetWeeklyAppointments	Gets the weekly appointments over the past current and next week comparison.
GET api/Account/Logoff	No documentation available.
GET api/Account/ForgotPassword	Forgot password functionality
GET api/Account/ChangePassword	Changes the password. Only if the user is authenticated
GET api/Account/SetPin	Sets the pin.
GET api/Account/ForgotPin	Forgots the pin.
GET api/Account/IsUserLockedOut?userName={userName}	No documentation available.
POST api/Account/CreateModelStateErrorMessage	Create failure output from model state errors.

Sphere

API	Description
GET api/Sphere/SaveCardResponse	No documentation available.
POST api/Sphere/CreateModelStateErrorMessage	Create failure output from model state errors.

PatientAccount

API	Description
POST api/PatientAccount/CreateModelStateErrorMessage	Create failure output from model state errors.

ClinicManagement

API	Description
POST api/ClinicManagement/UploadImageTemplate	No documentation available.
GET api/ClinicManagement/GetImageTemplatesList	No documentation available.
GET api/ClinicManagement/GetImageTemplate	No documentation available.
POST api/ClinicManagement/DeleteImageTemplate	No documentation available.
GET api/ClinicManagement/GetClinicInfo	Gets the clinic information.
POST api/ClinicManagement/PostClinicInfo	Posts the clinic information.
POST api/ClinicManagement/PostClinicContactInfo	Posts the clinic contact information.
GET api/ClinicManagement/GetClinicLocations	Gets the clinic locations.
GET api/ClinicManagement/GetClinicLocation?AppContextId={AppContextId}&Parameter={Parameter}	Gets the clinic location.
POST api/ClinicManagement/PostClinicLocation	Posts the clinic location.
GET api/ClinicManagement/GetClinicLocationRooms?AppContextId={AppContextId}&Parameter={Parameter}	Gets the clinic location rooms.
GET api/ClinicManagement/GetClinicLocationRoom	Gets the clinic location room.
POST api/ClinicManagement/PostClinicLocationRoom	Posts the clinic location room details for update/save.
GET api/ClinicManagement/GetClinicServices	Gets the clinic services.
GET api/ClinicManagement/GetClinicPractitioners	Gets the clinic practitioners.
GET api/ClinicManagement/GetClinicPractitionersAndInterns	No documentation available.
GET api/ClinicManagement/GetClinicInventoryMediums	No documentation available.
POST api/ClinicManagement/PostClinicServicesForRoom	Posts the clinic services for room.
GET api/ClinicManagement/GetInventoryItems	No documentation available.
GET api/ClinicManagement/GetPractitionerAvatarFile	No documentation available.
GET api/ClinicManagement/GetInventoryCategories	No documentation available.
POST api/ClinicManagement/CreateModelStateErrorMessage	Create failure output from model state errors.

Lead

API	Description
POST api/Lead/PostContactLead	Posts the contact lead.
POST api/Lead/PostRequestDemoLead	Posts the request demo lead.
GET api/Lead/GetLeadAreaOfInterests	Get area of interests.
GET api/Lead/GetLeadContactAdvertisements	Get contact advertisements.
GET api/Lead/GetStateProvinces	Get states and provinces.
GET api/Lead/GetLeadOccupations	Get lead occupations.
POST api/Lead/CreateModelStateErrorMessage	Create failure output from model state errors.

Intake

API	Description
GET api/Intake/GetIntake?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
GET api/Intake/GetIntakeNavigationList?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
GET api/Intake/GetIntakes	No documentation available.
POST api/Intake/IntakeCreate	No documentation available.
POST api/Intake/IntakeCreateTransactional	No documentation available.
POST api/Intake/IntakeClose	No documentation available.
POST api/Intake/IntakeSign	No documentation available.
POST api/Intake/IntakeChangeApprovalStatus	No documentation available.
POST api/Intake/IntakeSignAndClose	No documentation available.
POST api/Intake/IntakeUnlock	No documentation available.
GET api/Intake/GetIntakeNode?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
GET api/Intake/GetIntakeNodes	No documentation available.
POST api/Intake/AddIntakeNode	No documentation available.
POST api/Intake/AddIntakeNodes	No documentation available.
POST api/Intake/UpdateIntakeNode	No documentation available.
POST api/Intake/DeleteIntakeNode	No documentation available.
POST api/Intake/DeleteIntakeNodes	No documentation available.
POST api/Intake/CopyChart	No documentation available.
POST api/Intake/AddIntakeNodeAcuRx	No documentation available.
POST api/Intake/UpdateIntakeAcuRxNodesOrder	No documentation available.
POST api/Intake/UpdateIntakeAcuRxNodesDuration	No documentation available.
POST api/Intake/AddIntakeNodeErx	No documentation available.
POST api/Intake/UpdateIntakeNodeErx	No documentation available.
POST api/Intake/DeleteIntakeNodeErx	No documentation available.
POST api/Intake/DeleteIntakeNodesErx	No documentation available.
GET api/Intake/GetIntakeMedia?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
GET api/Intake/GetIntakeMedias	No documentation available.
GET api/Intake/GetGalleryIntakeMedias	No documentation available.
POST api/Intake/AddIntakeMedia	No documentation available.
POST api/Intake/UpdateIntakeMedia	No documentation available.
POST api/Intake/DeleteIntakeMedia	No documentation available.
POST api/Intake/SendIntakeMediaFile?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
GET api/Intake/GetIntakeMediaFile?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
GET api/Intake/GetIntakeMediaFileThumbnail?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
GET api/Intake/GetProtocols?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
POST api/Intake/AddProtocol	No documentation available.
POST api/Intake/DeleteProtocol	No documentation available.
GET api/Intake/GetIntakePrint	No documentation available.
GET api/Intake/GetSupervisorHasInReviewIntakes	No documentation available.
GET api/Intake/GetInternHasRejectedIntakes	No documentation available.
POST api/Intake/ApplyProtocol	No documentation available.
GET api/Intake/GetIntakeAmendments?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
POST api/Intake/AddAmendment	No documentation available.
POST api/Intake/AddCustomDictionaryItem	No documentation available.
POST api/Intake/UpdateCustomDictionaryItem	No documentation available.
POST api/Intake/RemoveCustomDictionaryItem	No documentation available.
GET api/Intake/GetCustomDictionaryItems	No documentation available.
POST api/Intake/CreateModelStateErrorMessage	Create failure output from model state errors.

Rx

API	Description
GET api/Rx/ValidatePatientEmailForRxIntegration	No documentation available.
POST api/Rx/UpdatePatientEmail	No documentation available.
POST api/Rx/CreateModelStateErrorMessage	Create failure output from model state errors.

BaseApi

API	Description
POST api/BaseApi/CreateModelStateErrorMessage	Create failure output from model state errors.

Helioscript

API	Description
GET api/Helioscript/TermsAndConditionsUrl	No documentation available.
GET api/Helioscript/PrivacyPolicyUrl	No documentation available.
GET api/Helioscript/AgreeAndNotifyClinicAdministrators	No documentation available.
GET api/Helioscript/AgreeAndCreateDraft?intakeId={intakeId}	No documentation available.
GET api/Helioscript/PractitionerHasHelioscriptAccount	No documentation available.
GET api/Helioscript/ValidatePatientEmailForRxIntegration	No documentation available.
POST api/Helioscript/UpdatePatientEmail	No documentation available.
POST api/Helioscript/CreateModelStateErrorMessage	Create failure output from model state errors.

Dictionary

API	Description
GET api/Dictionary/GetDictionaryList	No documentation available.
GET api/Dictionary/GetDictionaryFile	No documentation available.
POST api/Dictionary/CreateModelStateErrorMessage	Create failure output from model state errors.

Notifications

API	Description
POST api/Notifications/SendSmsNotification	No documentation available.

ClinicDataProvider

API	Description
GET api/ClinicDataProvider/CollectPendoStats	No documentation available.
POST api/ClinicDataProvider/GetResources	No documentation available.
GET api/ClinicDataProvider/GetClinicSettings	No documentation available.
POST api/ClinicDataProvider/GetLocation	No documentation available.
GET api/ClinicDataProvider/GetClinicLogo	No documentation available.
GET api/ClinicDataProvider/GetClinicInfo?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
POST api/ClinicDataProvider/UnloadClinicInfo	No documentation available.
POST api/ClinicDataProvider/CreateModelStateErrorMessage	Create failure output from model state errors.

Fullscript

API	Description
GET api/Fullscript/GetFullscriptLoginProviderToken	No documentation available.
GET api/Fullscript/GetPrescriptionPageLink?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
POST api/Fullscript/CreateModelStateErrorMessage	Create failure output from model state errors.

Utility

API	Description
GET api/Utility/GetLinkedData	No documentation available.
POST api/Utility/CreateLinkedData	No documentation available.
POST api/Utility/RemoveLinkedItem	No documentation available.
GET api/Utility/IsSessionAlive	No documentation available.
POST api/Utility/CreateModelStateErrorMessage	Create failure output from model state errors.

Anonymous

API	Description
HEAD api/Anonymous/HeadConnectivity	No documentation available.
POST api/Anonymous/FullscriptTreatmentPlanWebHook	No documentation available.

CalendarPatientFile

API	Description
GET api/CalendarPatientFile/GetPatientFile	Gets the list of appointments for a given practitioner
GET api/CalendarPatientFile/GetPersonalAndDemographic	No documentation available.
POST api/CalendarPatientFile/SavePersonalAndDemographic	No documentation available.
GET api/CalendarPatientFile/GetContactAndEmergency	No documentation available.
POST api/CalendarPatientFile/SaveContactAndEmergency	No documentation available.
GET api/CalendarPatientFile/GetInsuranceVerification	No documentation available.
GET api/CalendarPatientFile/GetDocuments	No documentation available.
POST api/CalendarPatientFile/SaveDocuments	No documentation available.
GET api/CalendarPatientFile/GetExplanationOfBenefits	No documentation available.
POST api/CalendarPatientFile/SaveExplanationOfBenefits	No documentation available.
GET api/CalendarPatientFile/GetOnboardingForms	No documentation available.
POST api/CalendarPatientFile/CreateModelStateErrorMessage	Create failure output from model state errors.

Setting

API	Description
GET api/Setting/DeviceRegister	Register a device to the server and get server settings.
GET api/Setting/DeviceOpen	Action done when an Ipad app is started in order to check the version
GET api/Setting/GetToolbarItems?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
POST api/Setting/SaveToolbarItems	No documentation available.
POST api/Setting/CreateModelStateErrorMessage	Create failure output from model state errors.

Content

API	Description
GET api/Content/GetOnboardingForm	Get onboarding form by OnboardingForm unique ID.
POST api/Content/OnboardingForm	Called when the [form] is saved.
POST api/Content/CreateModelStateErrorMessage	Create failure output from model state errors.

Calendar

API	Description
GET api/Calendar/GetPatients	No documentation available.
GET api/Calendar/GetMatchingPatients	No documentation available.
GET api/Calendar/GetAppointments	Gets the list of appointments for a given practitioner
GET api/Calendar/GetAppointmentsShortList	No documentation available.
GET api/Calendar/GetAppointmentsShortList_Paged	No documentation available.
GET api/Calendar/GetAppointment	Gets the list of appointments for a given practitioner
POST api/Calendar/PractitionerAppointmentUpdate	Updates an Appointment.
POST api/Calendar/PractitionerAppointmentUpdate_CancellationPolicy	No documentation available.
POST api/Calendar/PersonalAppointmentUpdate	Updates a personal appointment.
POST api/Calendar/PractitionerAppointmentAdd	Appointments the add.
POST api/Calendar/PersonalAppointmentAdd	Add personal appointment.
POST api/Calendar/GetOverlappingAppointments	No documentation available.
GET api/Calendar/CheckAppointment	No documentation available.
GET api/Calendar/PersonalAppointmentDelete?AppContextId={AppContextId}&Parameter={Parameter}	Remove personal appointment.
GET api/Calendar/GetNewAppointment	No documentation available.
GET api/Calendar/GetNewPersonalAppointment	Gets the new empty personal appointment.
GET api/Calendar/GetLocationServices	Gets the location specific data by using a location id and a patient type.
GET api/Calendar/LocationServiceLocationSpecificData	No documentation available.
GET api/Calendar/SendEmailToCompleteForms	Send email to complete forms.
GET api/Calendar/GetAppointmentsForSync	No documentation available.
POST api/Calendar/MarkAppointmentAsSynced	No documentation available.
GET api/Calendar/GetAvailableSlots	No documentation available.
GET api/Calendar/GetAppointmentRequestBillingInfo?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
GET api/Calendar/SendPatientPortalInvite?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
POST api/Calendar/RequestAsync?requestUri={requestUri}	No documentation available.
POST api/Calendar/CreateModelStateErrorMessage	Create failure output from model state errors.

Billing

API	Description
GET api/Billing/PrintPatientStatements	No documentation available.
GET api/Billing/GetIcdCodes?PractitionerId={PractitionerId}&QuickFilter={QuickFilter}&IsFavorite={IsFavorite}&IcdIndicatorType={IcdIndicatorType}	No documentation available.
POST api/Billing/ChangeICDFavoriteState	No documentation available.
GET api/Billing/GetAppointmentIcds?intakeId={intakeId}	No documentation available.
GET api/Billing/GetAppointmentIcds?appId={appId}&intakeId={intakeId}	No documentation available.
POST api/Billing/SaveAppointmentIcds	No documentation available.
GET api/Billing/GetClinicCpts	No documentation available.
GET api/Billing/GetAppointmentCpts?appId={appId}	No documentation available.
POST api/Billing/SaveAppointmentCPTs	No documentation available.
POST api/Billing/SaveBillingInfo	No documentation available.
POST api/Billing/SaleSuccess/{id}?uid={uid}	No documentation available.
POST api/Billing/SaveAdjustment	No documentation available.
POST api/Billing/SendPaymentLinkNotification?calendarAppointmentId={calendarAppointmentId}&notificationType={notificationType}	No documentation available.
GET api/Billing/RefreshPatientBillingStatus?patientId={patientId}	No documentation available.
POST api/Billing/UpdatePaymentDetails	No documentation available.
GET api/Billing/GetReceivePaymentForm?patientId={patientId}&entityId={entityId}&saleType={saleType}	No documentation available.
POST api/Billing/WalletPayment	No documentation available.
POST api/Billing/SuccessSale?response={response}	No documentation available.
POST api/Billing/ReceivePayment?saleType={saleType}	No documentation available.
POST api/Billing/IssuePaymentReceipt/{id}?patientId={patientId}&emailReceiptTo={emailReceiptTo}&returnReceipt={returnReceipt}	No documentation available.
GET api/Billing/GetTerminals?patientId={patientId}	No documentation available.
POST api/Billing/BootGridAppointmentBillingCPTs	No documentation available.
POST api/Billing/BootGridInventoryItems	No documentation available.
POST api/Billing/GetFullsteamAuthenticationKey	No documentation available.
POST api/Billing/SwipeCard?swipeResult={swipeResult}&amount={amount}&patientId={patientId}&saveCardToken={saveCardToken}	No documentation available.
POST api/Billing/ChargeTerminal?terminalId={terminalId}&amount={amount}&patientId={patientId}	No documentation available.
POST api/Billing/CancelChargeTerminal?terminalId={terminalId}	No documentation available.
POST api/Billing/PrintReceipt?terminalId={terminalId}&transactionId={transactionId}&patientId={patientId}&applicationScreen={applicationScreen}	No documentation available.
POST api/Billing/CreateModelStateErrorMessage	Create failure output from model state errors.

PatientManagement

API	Description
POST api/PatientManagement/SearchPatients	Searches my patients.
POST api/PatientManagement/SearchPatientsOfClinic	Searches the patients of my clinic.
POST api/PatientManagement/SearchPatientsOfPractitioner	Searches the patients of practitioner if a PractitionerPersonId is given or of the whole clinic otherwise
GET api/PatientManagement/GetPatientById	Gets the patient by identifier.
GET api/PatientManagement/GetPatientByCode	Gets the patient by code.
GET api/PatientManagement/GetPatientByName	Gets the patient by name.
GET api/PatientManagement/GetPatientContactByCode	Gets the patient contact by code.
POST api/PatientManagement/BuildParameterMessage	No documentation available.
GET api/PatientManagement/GetPatientContactById	Gets the patient contact by identifier.
POST api/PatientManagement/UpdatePatient	Updates the patient.
GET api/PatientManagement/ArchivePatient	Archives the patient.
GET api/PatientManagement/UnarchivePatient	No documentation available.
POST api/PatientManagement/InsertPatient	Inserts the patient.
POST api/PatientManagement/UpdatePatientContact	Updates the patient contact.
GET api/PatientManagement/GetPatientAvatarFile	No documentation available.
POST api/PatientManagement/SendPatientAvatarFile?AppContextId={AppContextId}&Parameter={Parameter}	No documentation available.
GET api/PatientManagement/PatientDocumentsList	No documentation available.
POST api/PatientManagement/SendPatientDocumentFile	No documentation available.
POST api/PatientManagement/UploadPatientFileDocument	No documentation available.
POST api/PatientManagement/UploadInsuranceDocument	No documentation available.
POST api/PatientManagement/DeleteInsuranceDocument	No documentation available.
GET api/PatientManagement/GetPatientDocumentFile	No documentation available.
GET api/PatientManagement/GetPatientInsuranceDocumentFile	No documentation available.
POST api/PatientManagement/RemovePatientDocumentFile	No documentation available.
POST api/PatientManagement/RemovePatientDocument	No documentation available.
GET api/PatientManagement/PatientFile_OnboardingForms	No documentation available.
GET api/PatientManagement/GetPatientConsentPdf	No documentation available.
POST api/PatientManagement/SignPatientConsentForms	No documentation available.
GET api/PatientManagement/GetOnboardingForm	No documentation available.
POST api/PatientManagement/SaveOnboardingForm	No documentation available.
GET api/PatientManagement/GetPatientFile	No documentation available.
GET api/PatientManagement/GetPersonalAndDemographic	No documentation available.
POST api/PatientManagement/SavePersonalAndDemographic	No documentation available.
GET api/PatientManagement/GetContactAndEmergency	No documentation available.
POST api/PatientManagement/SaveContactAndEmergency	No documentation available.
GET api/PatientManagement/GetInsuranceVerification	No documentation available.
POST api/PatientManagement/SaveInsuranceBasicVerification	No documentation available.
POST api/PatientManagement/SaveInsuranceAutoAccidentVerification	No documentation available.
POST api/PatientManagement/SaveInsuranceWorkerCompensationVerification	No documentation available.
GET api/PatientManagement/GetExplanationOfBenefits	No documentation available.
POST api/PatientManagement/SaveExplanationOfBenefits	No documentation available.
GET api/PatientManagement/GetVitalInformation	No documentation available.
POST api/PatientManagement/SaveVitalInformation	No documentation available.
GET api/PatientManagement/PatientFile_DocumentsGet	No documentation available.
POST api/PatientManagement/SavePatientMedical	No documentation available.
GET api/PatientManagement/GetPatientMedical	No documentation available.
GET api/PatientManagement/GetPatientMedicalAdditional	No documentation available.
POST api/PatientManagement/SavePatientMedicalAdditional	No documentation available.
POST api/PatientManagement/GetPatientOnboardingProgress	No documentation available.
POST api/PatientManagement/CreateModelStateErrorMessage	Create failure output from model state errors.

Alerts

API	Description
GET api/Alerts/GetClinicAlertInApp?AppContextId={AppContextId}&Parameter={Parameter}&designTemplateName={designTemplateName}	Get in-app clinic alert.
GET api/Alerts/GetClinicAlertInApps	Filter in-app clinic alerts.
POST api/Alerts/SetClinicAlertInAppViewed	Set in-app clinic alert as viewed or not.
POST api/Alerts/SetClinicAlertsInAppStatus	No documentation available.
POST api/Alerts/CreateModelStateErrorMessage	Create failure output from model state errors.