PV API Service

<back to all web services

PatientFlowSettingsRequest

GET a list of patient flow setting records for an entire practice.

The following routes are available for this service:
GET, OPTIONS/PatientFlow/Settings/{Practice}

To override the Content-type in your clients HTTP Accept Header, append ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/PatientFlowSettingsRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: text/jsv
Content-Length: length

{
	practice: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	practiceName: String,
	practicePk: 00000000000000000000000000000000,
	clinics: 
	[
		{
			clinicName: String,
			clinicNum: 0,
			clinicPk: 00000000000000000000000000000000,
			description: String,
			showOnPatientFlowDashboard: False,
			dashboardSettings: 
			{
				patientFlowSettingID: 0,
				practicePK: 00000000000000000000000000000000,
				clinicPK: 00000000000000000000000000000000,
				avgWaitTimeAlert: 0,
				avgWaitTimeWarn: 0,
				maxWaitTimeAlert: 0,
				maxWaitTimeWarn: 0,
				patientCurrentAlert: 0,
				patientCurrentWarn: 0,
				inExamAlert: 0,
				inExamWarn: 0,
				avgTotalTimeInClinicAlert: 0,
				avgTotalTimeInClinicWarn: 0,
				maxTotalTimeInClinicAlert: 0,
				maxTotalTimeInClinicWarn: 0,
				avgTimeInExamAlert: 0,
				aveTimeInExamWarn: 0,
				maxTimeInExamAlert: 0,
				maxTimeInExamWarn: 0
			}
		}
	],
	dashboardSettings: 
	{
		patientFlowSettingID: 0,
		practicePK: 00000000000000000000000000000000,
		clinicPK: 00000000000000000000000000000000,
		avgWaitTimeAlert: 0,
		avgWaitTimeWarn: 0,
		maxWaitTimeAlert: 0,
		maxWaitTimeWarn: 0,
		patientCurrentAlert: 0,
		patientCurrentWarn: 0,
		inExamAlert: 0,
		inExamWarn: 0,
		avgTotalTimeInClinicAlert: 0,
		avgTotalTimeInClinicWarn: 0,
		maxTotalTimeInClinicAlert: 0,
		maxTotalTimeInClinicWarn: 0,
		avgTimeInExamAlert: 0,
		aveTimeInExamWarn: 0,
		maxTimeInExamAlert: 0,
		maxTimeInExamWarn: 0
	}
}