ws

Click here for a complete list of operations.

GetCallDashBoardData

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Integration/ENT/V1.8/ws.asmx HTTP/1.1
Host: implementation.hhaexchange.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.hhaexchange.com/apis/hhaws.integration/GetCallDashBoardData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCallDashBoardData xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <SearchFilters>
        <OfficeID>int</OfficeID>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <PatientID>int</PatientID>
        <AdmissionID>string</AdmissionID>
        <CaregiverID>int</CaregiverID>
        <CaregiverCode>string</CaregiverCode>
        <TimeAndAttendancePIN>int</TimeAndAttendancePIN>
        <LastCallDashboardID>int</LastCallDashboardID>
      </SearchFilters>
    </GetCallDashBoardData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCallDashBoardDataResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCallDashBoardDataResult>
        <Calls>
          <CallInfo>
            <CallDashboardID>int</CallDashboardID>
            <Caregiver xsi:nil="true" />
            <Patient xsi:nil="true" />
            <CallTime>string</CallTime>
            <CallType>string</CallType>
            <CallStatus>string</CallStatus>
            <DutiesPerformed xsi:nil="true" />
          </CallInfo>
          <CallInfo>
            <CallDashboardID>int</CallDashboardID>
            <Caregiver xsi:nil="true" />
            <Patient xsi:nil="true" />
            <CallTime>string</CallTime>
            <CallType>string</CallType>
            <CallStatus>string</CallStatus>
            <DutiesPerformed xsi:nil="true" />
          </CallInfo>
        </Calls>
      </GetCallDashBoardDataResult>
    </GetCallDashBoardDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Integration/ENT/V1.8/ws.asmx HTTP/1.1
Host: implementation.hhaexchange.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetCallDashBoardData xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <SearchFilters>
        <OfficeID>int</OfficeID>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <PatientID>int</PatientID>
        <AdmissionID>string</AdmissionID>
        <CaregiverID>int</CaregiverID>
        <CaregiverCode>string</CaregiverCode>
        <TimeAndAttendancePIN>int</TimeAndAttendancePIN>
        <LastCallDashboardID>int</LastCallDashboardID>
      </SearchFilters>
    </GetCallDashBoardData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetCallDashBoardDataResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCallDashBoardDataResult>
        <Calls>
          <CallInfo>
            <CallDashboardID>int</CallDashboardID>
            <Caregiver xsi:nil="true" />
            <Patient xsi:nil="true" />
            <CallTime>string</CallTime>
            <CallType>string</CallType>
            <CallStatus>string</CallStatus>
            <DutiesPerformed xsi:nil="true" />
          </CallInfo>
          <CallInfo>
            <CallDashboardID>int</CallDashboardID>
            <Caregiver xsi:nil="true" />
            <Patient xsi:nil="true" />
            <CallTime>string</CallTime>
            <CallType>string</CallType>
            <CallStatus>string</CallStatus>
            <DutiesPerformed xsi:nil="true" />
          </CallInfo>
        </Calls>
      </GetCallDashBoardDataResult>
    </GetCallDashBoardDataResponse>
  </soap12:Body>
</soap12:Envelope>