ws

Click here for a complete list of operations.

ConfirmVisitsV2

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/ConfirmVisitsV2"

<?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>
    <ConfirmVisitsV2 xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitV2Info>
        <CaregiverID>int</CaregiverID>
        <VisitID>long</VisitID>
        <TimeAndAttPIN>int</TimeAndAttPIN>
        <CaregiverCode>string</CaregiverCode>
        <PatientID>int</PatientID>
        <CallerID>long</CallerID>
        <AdmissionID>string</AdmissionID>
        <VisitStartTime>dateTime</VisitStartTime>
        <StartLatitude>decimal</StartLatitude>
        <StartLongitude>decimal</StartLongitude>
        <VisitEndTime>dateTime</VisitEndTime>
        <EndLatitude>decimal</EndLatitude>
        <EndLongitude>decimal</EndLongitude>
        <ReasonCode>int</ReasonCode>
        <ActionCode>int</ActionCode>
        <Duties>
          <Duty>
            <DutyCode>int</DutyCode>
            <AdditionalData>decimal</AdditionalData>
            <Status>string</Status>
            <RefusedReasonCode>int</RefusedReasonCode>
          </Duty>
          <Duty>
            <DutyCode>int</DutyCode>
            <AdditionalData>decimal</AdditionalData>
            <Status>string</Status>
            <RefusedReasonCode>int</RefusedReasonCode>
          </Duty>
        </Duties>
        <TimesheetRequired>string</TimesheetRequired>
        <TimesheetApproved>string</TimesheetApproved>
        <Notes>string</Notes>
        <MealInterruptMinutes>int</MealInterruptMinutes>
        <SleepInterruptMinutes>int</SleepInterruptMinutes>
        <CallDuration>int</CallDuration>
      </VisitV2Info>
    </ConfirmVisitsV2>
  </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>
    <ConfirmVisitsV2Response xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <ConfirmVisitsV2Result>
        <VisitID>long</VisitID>
        <Status>string</Status>
        <Comments>string</Comments>
      </ConfirmVisitsV2Result>
    </ConfirmVisitsV2Response>
  </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>
    <ConfirmVisitsV2 xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitV2Info>
        <CaregiverID>int</CaregiverID>
        <VisitID>long</VisitID>
        <TimeAndAttPIN>int</TimeAndAttPIN>
        <CaregiverCode>string</CaregiverCode>
        <PatientID>int</PatientID>
        <CallerID>long</CallerID>
        <AdmissionID>string</AdmissionID>
        <VisitStartTime>dateTime</VisitStartTime>
        <StartLatitude>decimal</StartLatitude>
        <StartLongitude>decimal</StartLongitude>
        <VisitEndTime>dateTime</VisitEndTime>
        <EndLatitude>decimal</EndLatitude>
        <EndLongitude>decimal</EndLongitude>
        <ReasonCode>int</ReasonCode>
        <ActionCode>int</ActionCode>
        <Duties>
          <Duty>
            <DutyCode>int</DutyCode>
            <AdditionalData>decimal</AdditionalData>
            <Status>string</Status>
            <RefusedReasonCode>int</RefusedReasonCode>
          </Duty>
          <Duty>
            <DutyCode>int</DutyCode>
            <AdditionalData>decimal</AdditionalData>
            <Status>string</Status>
            <RefusedReasonCode>int</RefusedReasonCode>
          </Duty>
        </Duties>
        <TimesheetRequired>string</TimesheetRequired>
        <TimesheetApproved>string</TimesheetApproved>
        <Notes>string</Notes>
        <MealInterruptMinutes>int</MealInterruptMinutes>
        <SleepInterruptMinutes>int</SleepInterruptMinutes>
        <CallDuration>int</CallDuration>
      </VisitV2Info>
    </ConfirmVisitsV2>
  </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>
    <ConfirmVisitsV2Response xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <ConfirmVisitsV2Result>
        <VisitID>long</VisitID>
        <Status>string</Status>
        <Comments>string</Comments>
      </ConfirmVisitsV2Result>
    </ConfirmVisitsV2Response>
  </soap12:Body>
</soap12:Envelope>