ws Web Service

Click here for a complete list of operations.

GetScheduleInfo

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: app.hhaexchange.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.hhaexchange.com/apis/hhaws.integration/GetScheduleInfo"

<?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>
    <GetScheduleInfo xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <ScheduleInfo>
        <ID>int</ID>
      </ScheduleInfo>
    </GetScheduleInfo>
  </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>
    <GetScheduleInfoResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetScheduleInfoResult>
        <ScheduleInfo>
          <ID>int</ID>
          <VisitType>string</VisitType>
          <VisitDate>string</VisitDate>
          <Patient>
            <ID>int</ID>
            <AdmissionNumber>string</AdmissionNumber>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
          </Patient>
          <Caregiver>
            <ID>int</ID>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <CaregiverCode>int</CaregiverCode>
            <TimeAndAttendancePIN>int</TimeAndAttendancePIN>
            <PayCode xsi:nil="true" />
          </Caregiver>
          <ScheduleStartTime>string</ScheduleStartTime>
          <ScheduleEndTime>string</ScheduleEndTime>
          <PrimaryBillTo>
            <Contract xsi:nil="true" />
            <ServiceCode xsi:nil="true" />
            <Hours>int</Hours>
            <Minutes>int</Minutes>
          </PrimaryBillTo>
          <SecondaryBillTo>
            <Contract xsi:nil="true" />
            <ServiceCode xsi:nil="true" />
            <Hours>int</Hours>
            <Minutes>int</Minutes>
          </SecondaryBillTo>
          <LastModifiedDate>string</LastModifiedDate>
        </ScheduleInfo>
      </GetScheduleInfoResult>
    </GetScheduleInfoResponse>
  </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: app.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>
    <GetScheduleInfo xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <ScheduleInfo>
        <ID>int</ID>
      </ScheduleInfo>
    </GetScheduleInfo>
  </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>
    <GetScheduleInfoResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetScheduleInfoResult>
        <ScheduleInfo>
          <ID>int</ID>
          <VisitType>string</VisitType>
          <VisitDate>string</VisitDate>
          <Patient>
            <ID>int</ID>
            <AdmissionNumber>string</AdmissionNumber>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
          </Patient>
          <Caregiver>
            <ID>int</ID>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <CaregiverCode>int</CaregiverCode>
            <TimeAndAttendancePIN>int</TimeAndAttendancePIN>
            <PayCode xsi:nil="true" />
          </Caregiver>
          <ScheduleStartTime>string</ScheduleStartTime>
          <ScheduleEndTime>string</ScheduleEndTime>
          <PrimaryBillTo>
            <Contract xsi:nil="true" />
            <ServiceCode xsi:nil="true" />
            <Hours>int</Hours>
            <Minutes>int</Minutes>
          </PrimaryBillTo>
          <SecondaryBillTo>
            <Contract xsi:nil="true" />
            <ServiceCode xsi:nil="true" />
            <Hours>int</Hours>
            <Minutes>int</Minutes>
          </SecondaryBillTo>
          <LastModifiedDate>string</LastModifiedDate>
        </ScheduleInfo>
      </GetScheduleInfoResult>
    </GetScheduleInfoResponse>
  </soap12:Body>
</soap12:Envelope>