NEXA.QFlowWebAPI

Introduction

Provide a general description of your APIs here.

Appointments

Appointment related information

API	Description
GET Appointments?offset={offset}&limit={limit}&Status={Status}&PersonalId={PersonalId}&CreatedAfterDate={CreatedAfterDate}&CreatedBeforeDate={CreatedBeforeDate}&DueAfterDate={DueAfterDate}&DueBeforeDate={DueBeforeDate}&UnitId={UnitId}&AppointmentType={AppointmentType}&CaseExtRef={CaseExtRef}&ProcessId={ProcessId}&CaseId={CaseId}	No documentation available.
GET Appointments/{id}	Get a single appointment
PUT Appointments	Create New Appointment
POST Appointments/ExtRef	Create New Appointment using External References (no refernces to QFlow internal indexes). Overload using ExtRef's instead of ServiceId, AppointmentId, CustomerId
PATCH Appointments	Reschedule an existing (future) appointment. If the appointment is part of a group/family appointment, all appointments are rescheduled in sequence starting with the time provided. The first person of the group will get the start time. If rescheduling the 2nd person, they will get the next time slot after the first start time.
DELETE Appointments/ExtRef/{extRef}	No documentation available.
DELETE Appointments	Cancel an appointment
DELETE Appointments/ExtRef	No documentation available.
POST Appointments/Checkin	Check-in (Enqueue/Arrive) an appointment
POST Appointments/CheckinExtRef	No documentation available.
POST Appointments/Status	No documentation available.

Calendars

Search calendars in QFlow. A calendar is only one day of one service.

API	Description
GET Calendars/AvailableCounts?ServiceId={ServiceId}&StartDate={StartDate}&EndDate={EndDate}	Get available slot counts for each day (using default Appointment type/duration) [Overload also available for ExtRefs]
GET Calendars/AvailableCounts?UnitExtRef={UnitExtRef}&ServiceExtRef={ServiceExtRef}&AppointmentTypeExtRef={AppointmentTypeExtRef}&StartDate={StartDate}&EndDate={EndDate}	Get available slot counts for each day (using default Appointment type/duration) Overload of ExtRef instead of ServiceId. Unit, Service and/or AppointmentType ExtRef MUST resolve to the first matching service
GET Calendars/Times?ServiceId={ServiceId}&StartDate={StartDate}&EndDate={EndDate}&AppointmentTypeId={AppointmentTypeId}&SlotsNeeded={SlotsNeeded}	Get the calendar's suggested slot start times and availability
GET Calendars/Times?UnitExtRef={UnitExtRef}&ServiceExtRef={ServiceExtRef}&AppointmentTypeExtRef={AppointmentTypeExtRef}&StartDate={StartDate}&EndDate={EndDate}&SlotsNeeded={SlotsNeeded}	Get the calendar's suggested slot start times and availability Overload of ExtRef instead of ServiceId. Unit, Service and/or AppointmentType ExtRef MUST resolve to the first matching service
GET Calendars/WeekTimes?ServiceId={ServiceId}&StartDate={StartDate}&AppointmentTypeId={AppointmentTypeId}	Get a matrix of calendar's suggested slot times for the whole calander week. Preferable to use flat collection of /Calendars/Times as this is slower to run.
GET Calendars/WeekTimes?UnitExtRef={UnitExtRef}&ServiceExtRef={ServiceExtRef}&AppointmentTypeExtRef={AppointmentTypeExtRef}&StartDate={StartDate}	Get a matrix of calendar's suggested slot times for the whole calander week. Overload of ExtRef instead of ServiceId. Unit, Service and/or AppointmentType ExtRef MUST resolve to the first matching service Preferable to use flat collection of /Calendars/Times as this is slower to run.
GET Calendars/FirstAvailable?ServiceId={ServiceId}&StartDate={StartDate}&EndDate={EndDate}&CheckMondays={CheckMondays}&CheckTuesdays={CheckTuesdays}&CheckWednesdays={CheckWednesdays}&CheckThursdays={CheckThursdays}&CheckFridays={CheckFridays}&CheckSaturdays={CheckSaturdays}&CheckSundays={CheckSundays}&AppointmentTypeId={AppointmentTypeId}&SlotsNeeded={SlotsNeeded}	Get first available slot date and time fitting the criteria
GET Calendars/FirstAvailable?UnitExtRef={UnitExtRef}&ServiceExtRef={ServiceExtRef}&AppointmentTypeExtRef={AppointmentTypeExtRef}&StartDate={StartDate}&EndDate={EndDate}&CheckMondays={CheckMondays}&CheckTuesdays={CheckTuesdays}&CheckWednesdays={CheckWednesdays}&CheckThursdays={CheckThursdays}&CheckFridays={CheckFridays}&CheckSaturdays={CheckSaturdays}&CheckSundays={CheckSundays}&SlotsNeeded={SlotsNeeded}	Get first available slot date and time fitting the criteria Overload of ExtRef instead of ServiceId. Unit, Service and/or AppointmentType ExtRef MUST resolve to the first matching service

Cases

Case creation and retrieval

API	Description
GET Cases?offset={offset}&limit={limit}&Status={Status}&CreatedBeforeDate={CreatedBeforeDate}&CreatedAfterDate={CreatedAfterDate}&LastUpdateAfterDate={LastUpdateAfterDate}&LastUpdateBeforeDate={LastUpdateBeforeDate}&UnitType={UnitType}&UnitId={UnitId}&ServiceId={ServiceId}&PersonalId={PersonalId}&ExtRef={ExtRef}&CustomProperty={CustomProperty}&CustomPropertyValue={CustomPropertyValue}	No documentation available.
GET Cases/{id}	Get detail about the case
GET Cases/Processes/{id}	Get detail about the case via the Process Id
POST Cases	Case Enqueue for FIFO
PATCH Cases	Update the status of a case included documenting it
POST Cases/Cancel	No documentation available.
DELETE Cases?CaseId={CaseId}	No documentation available.
POST Cases/UpdateFeedback	No documentation available.

ContactTracing

API	Description
POST ContactTracing	No documentation available.
PUT ContactTracing?contactDetailIds={contactDetailIds}&unitId={unitId}	No documentation available.

Customers

Customer related information

API	Description
GET Customers/{id}?idType={idType}&idTypeExtRef={idTypeExtRef}	No documentation available.
GET Customers?offset={offset}&limit={limit}&PersonalId={PersonalId}&FirstName={FirstName}&LastName={LastName}&IsActive={IsActive}	Get a list of customers and related information. Sorted by LastName, FirstName, CustomerId
POST Customers	Create new customer record or Update Existing record. If Updating existing record, pass valid PersonalId If Creating new record, pass the Unique PersonalId
PATCH Customers	Update Existing customer record. If Updating existing record, pass valid PersonalId
PUT Customers	No documentation available.

Device

Device Controller (used by NEXA Device Controller and Monitor)

API	Description
POST Device/Login	Device Login (typically from NEXA.DeviceController)
POST Device/Logout	Device Logout (typically from NEXA.DeviceController)
GET Device/PlayList/{deviceId}	Get play list items (media sequence) for the Smart Display Device
GET Device/PlayerInfo/{deviceId}	Get player information for the Smart Display Device
GET Device/AppUpdates?AppName={AppName}&CurrentVersion={CurrentVersion}	Check if there are any updates to a registered app, returning download paths
POST Device/IsAlive	Update QFlow and/or device lists to indicate that the device is still alive
GET Device/Status	No documentation available.

Menu reading methods

API	Description
GET Menu/Units/{id}?group={group}	No documentation available.
GET Menu/Services/{id}?group={group}	No documentation available.
GET Menu/Content/{id}	Get a list of menu items and services in working hours and enabled. Link to services in working hours and enabled if applic. if ServiceId=null then there will be child items. If !null then this is an end point Read qf.NEXAContentManagement
GET Menu/Content/{id}/{UnitId}	No documentation available.
GET Menu/ApplicationRoot/{Code}/{UnitId}	No documentation available.
GET Menu/Classifications/{id}	Get a list of Reception classifications for the selected service

Referrals

API	Description
GET Referrals	No documentation available.
GET Referrals/{id}	No documentation available.

Reports

API	Description
POST Reports	No documentation available.

Statistics

QFlow queuing statistics

API	Description
GET Statistics/Units?UnitType={UnitType}&UnitLevel={UnitLevel}&ParentUnitId={ParentUnitId}	Get Wait and Service counts and time statistics for each unit
GET Statistics/Units/Total?UnitType={UnitType}&UnitLevel={UnitLevel}&ParentUnitId={ParentUnitId}	Get Wait and Service counts and time statistics for all units (totalled)
GET Statistics/Units/{id}/Services	Get Wait and Service counts and time statistics for all service queues for a particular unit
GET Statistics/Units/{uid}/Services/{sid}/Agents	Get Agent level statistics for a Unit and optional service

System

General System Utilities

API	Description
POST System/Log	No documentation available.
POST System/Query	No documentation available.
GET System/ContentValue?TemplateName={TemplateName}&LanguageCode={LanguageCode}&ObjectId={ObjectId}	Get all of the Content value in the selected language and object
GET System/ContentValues?TemplateCategory={TemplateCategory}&LanguageCode={LanguageCode}&ObjectType={ObjectType}&ObjectId={ObjectId}	Get all of the Global Content Template default values in the selected language
GET System/ContentEnglish?TemplateName={TemplateName}	Get the Global Content Template Default in English (used for switches)
GET System/Config/{id}	No documentation available.
GET System/Config/{appId}/{id}	No documentation available.
GET System/ConfigDump	No documentation available.
POST System/Message	No documentation available.
GET System/Notifications/{id}	No documentation available.
POST System/Notifications	No documentation available.
POST System/Notifications/Template	No documentation available.
POST System/Notifications/Profile	No documentation available.
POST System/Notifications/Custom	No documentation available.
GET System/DeviceFiles	Get the Device Files
POST System/RecaptchaSiteVerify	No documentation available.
GET System/Status	No documentation available.

Tickets

QFlow ticket information

API	Description
GET Tickets/Waiting/{UnitId}	Get Waiting tickets for a unit
GET Tickets/WaitingAgent?UserName={UserName}	Get Waiting ticket count for all services a user agent has access to
GET Tickets/InService/{UnitId}	Get tickets in service

Units

Unit and Service related information

API	Description
GET Units/{id}	Get a single unit's details
GET Units?UnitId={UnitId}&UnitExtRef={UnitExtRef}&ServiceExtRef={ServiceExtRef}&ServiceTypeExtRef={ServiceTypeExtRef}&AppointmentTypeExtRef={AppointmentTypeExtRef}&AppointmentService={AppointmentService}&CompositeApptTypeExtRef={CompositeApptTypeExtRef}&IsActive={IsActive}&IncludeServices={IncludeServices}&IncludeApptTypes={IncludeApptTypes}&IgnoreWorkingHours={IgnoreWorkingHours}	Get a list of units, services and related information. Sorted by UnitPath, ServiceName, AppointmentTypeName
GET UnitsWithTypeExtRef?UnitId={UnitId}&UnitTypeExtRef={UnitTypeExtRef}&UnitExtRef={UnitExtRef}&ServiceExtRef={ServiceExtRef}&ServiceTypeExtRef={ServiceTypeExtRef}&AppointmentTypeExtRef={AppointmentTypeExtRef}&AppointmentService={AppointmentService}&CompositeApptTypeExtRef={CompositeApptTypeExtRef}&IsActive={IsActive}&IncludeServices={IncludeServices}&IncludeApptTypes={IncludeApptTypes}&IgnoreWorkingHours={IgnoreWorkingHours}	No documentation available.

Users

API	Description
POST Users/Token	No documentation available.
POST Users/LoginQFlow	No documentation available.
POST Users/Login	No documentation available.
POST Users/LoginPIN	No documentation available.
GET Users	No documentation available.
POST Users	No documentation available.
POST CreateAndRegister	No documentation available.
PATCH Users	No documentation available.
POST Users/Activate	No documentation available.
PATCH Users/Activate	No documentation available.
POST Users/Resend/{channel}	No documentation available.
POST Users/ResendCode/{codeType}	No documentation available.
POST Users/ResendNoAuth	No documentation available.
PATCH Users/Push	No documentation available.
GET Users/Push	No documentation available.
PUT Users	No documentation available.
DELETE Users	No documentation available.
POST Users/ResetPassword	No documentation available.
PATCH Users/ResetPassword	No documentation available.
PATCH Users/ChangePassword	No documentation available.
POST Users/ResetPIN	No documentation available.
PATCH Users/ResetPIN	No documentation available.
PATCH Users/ChangePIN	No documentation available.
POST Users/ChangeEmail	No documentation available.
PATCH Users/ChangeEmail	No documentation available.
POST Users/CheckUserCreateable	No documentation available.
POST Users/GuestLogin	No documentation available.
GET MobileHasMultiple/{mobile}	No documentation available.
POST Users/MobileLogin	No documentation available.
POST Users/MobileResetPassword	No documentation available.
PATCH Users/MobileResetPassword	No documentation available.
POST Users/MobileResetPIN	No documentation available.
PATCH Users/MobileResetPIN	No documentation available.
POST Users/MobileResetPINPassword	No documentation available.
GET Users/Notifications?RestrictToId={RestrictToId}&IncludeRead={IncludeRead}&Top={Top}	No documentation available.
GET Users/Notifications/{id}	No documentation available.
GET Users/Cleanup	No documentation available.