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=xml

HTTP + XML

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

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

<PatientFlowSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.PatientFlow">
  <Practice>String</Practice>
</PatientFlowSettingsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PatientFlowSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.PatientFlow">
  <Clinics>
    <Clinic>
      <ClinicName>String</ClinicName>
      <ClinicNum>0</ClinicNum>
      <ClinicPk>00000000-0000-0000-0000-000000000000</ClinicPk>
      <DashboardSettings>
        <AveTimeInExamWarn>0</AveTimeInExamWarn>
        <AvgTimeInExamAlert>0</AvgTimeInExamAlert>
        <AvgTotalTimeInClinicAlert>0</AvgTotalTimeInClinicAlert>
        <AvgTotalTimeInClinicWarn>0</AvgTotalTimeInClinicWarn>
        <AvgWaitTimeAlert>0</AvgWaitTimeAlert>
        <AvgWaitTimeWarn>0</AvgWaitTimeWarn>
        <ClinicPK>00000000-0000-0000-0000-000000000000</ClinicPK>
        <InExamAlert>0</InExamAlert>
        <InExamWarn>0</InExamWarn>
        <MaxTimeInExamAlert>0</MaxTimeInExamAlert>
        <MaxTimeInExamWarn>0</MaxTimeInExamWarn>
        <MaxTotalTimeInClinicAlert>0</MaxTotalTimeInClinicAlert>
        <MaxTotalTimeInClinicWarn>0</MaxTotalTimeInClinicWarn>
        <MaxWaitTimeAlert>0</MaxWaitTimeAlert>
        <MaxWaitTimeWarn>0</MaxWaitTimeWarn>
        <PatientCurrentAlert>0</PatientCurrentAlert>
        <PatientCurrentWarn>0</PatientCurrentWarn>
        <PatientFlowSettingID>0</PatientFlowSettingID>
        <PracticePK>00000000-0000-0000-0000-000000000000</PracticePK>
      </DashboardSettings>
      <Description>String</Description>
      <ShowOnPatientFlowDashboard>false</ShowOnPatientFlowDashboard>
    </Clinic>
  </Clinics>
  <DashboardSettings>
    <AveTimeInExamWarn>0</AveTimeInExamWarn>
    <AvgTimeInExamAlert>0</AvgTimeInExamAlert>
    <AvgTotalTimeInClinicAlert>0</AvgTotalTimeInClinicAlert>
    <AvgTotalTimeInClinicWarn>0</AvgTotalTimeInClinicWarn>
    <AvgWaitTimeAlert>0</AvgWaitTimeAlert>
    <AvgWaitTimeWarn>0</AvgWaitTimeWarn>
    <ClinicPK>00000000-0000-0000-0000-000000000000</ClinicPK>
    <InExamAlert>0</InExamAlert>
    <InExamWarn>0</InExamWarn>
    <MaxTimeInExamAlert>0</MaxTimeInExamAlert>
    <MaxTimeInExamWarn>0</MaxTimeInExamWarn>
    <MaxTotalTimeInClinicAlert>0</MaxTotalTimeInClinicAlert>
    <MaxTotalTimeInClinicWarn>0</MaxTotalTimeInClinicWarn>
    <MaxWaitTimeAlert>0</MaxWaitTimeAlert>
    <MaxWaitTimeWarn>0</MaxWaitTimeWarn>
    <PatientCurrentAlert>0</PatientCurrentAlert>
    <PatientCurrentWarn>0</PatientCurrentWarn>
    <PatientFlowSettingID>0</PatientFlowSettingID>
    <PracticePK>00000000-0000-0000-0000-000000000000</PracticePK>
  </DashboardSettings>
  <PracticeName>String</PracticeName>
  <PracticePk>00000000-0000-0000-0000-000000000000</PracticePk>
</PatientFlowSettingsResponse>