ws Web Service

Click here for a complete list of operations.

GetVisitPayrollInfo

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

<?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>
    <GetVisitPayrollInfo xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitPayrollInfo>
        <ID>int</ID>
      </VisitPayrollInfo>
    </GetVisitPayrollInfo>
  </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>
    <GetVisitPayrollInfoResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetVisitPayrollInfoResult>
        <VisitPayrollInfo>
          <ID>int</ID>
          <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>string</CaregiverCode>
            <TimeAndAttendancePIN>string</TimeAndAttendancePIN>
            <PayCode xsi:nil="true" />
            <DateofBirth>string</DateofBirth>
          </Caregiver>
          <ScheduleStartTime>string</ScheduleStartTime>
          <ScheduleEndTime>string</ScheduleEndTime>
          <VisitStartTime>string</VisitStartTime>
          <VisitEndTime>string</VisitEndTime>
          <IsMissedVisit>string</IsMissedVisit>
          <PrimaryContract>
            <ID>int</ID>
            <Name>string</Name>
          </PrimaryContract>
          <BillingServiceCode>
            <ID>int</ID>
            <Name>string</Name>
            <BillType>string</BillType>
          </BillingServiceCode>
          <BilledMinutes>int</BilledMinutes>
          <BilledAmount>decimal</BilledAmount>
          <PayrollAdjustmentMinutes>int</PayrollAdjustmentMinutes>
          <Payrolldate>string</Payrolldate>
          <RegularHours>
            <Minutes>decimal</Minutes>
            <Payrate>decimal</Payrate>
            <Amount>decimal</Amount>
            <PayCode xsi:nil="true" />
          </RegularHours>
          <OTHours>
            <Minutes>decimal</Minutes>
            <Payrate>decimal</Payrate>
            <Amount>decimal</Amount>
            <PayCode xsi:nil="true" />
          </OTHours>
          <HolidayHours>
            <Minutes>decimal</Minutes>
            <Payrate>decimal</Payrate>
            <Amount>decimal</Amount>
            <PayCode xsi:nil="true" />
          </HolidayHours>
        </VisitPayrollInfo>
      </GetVisitPayrollInfoResult>
    </GetVisitPayrollInfoResponse>
  </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>
    <GetVisitPayrollInfo xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitPayrollInfo>
        <ID>int</ID>
      </VisitPayrollInfo>
    </GetVisitPayrollInfo>
  </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>
    <GetVisitPayrollInfoResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetVisitPayrollInfoResult>
        <VisitPayrollInfo>
          <ID>int</ID>
          <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>string</CaregiverCode>
            <TimeAndAttendancePIN>string</TimeAndAttendancePIN>
            <PayCode xsi:nil="true" />
            <DateofBirth>string</DateofBirth>
          </Caregiver>
          <ScheduleStartTime>string</ScheduleStartTime>
          <ScheduleEndTime>string</ScheduleEndTime>
          <VisitStartTime>string</VisitStartTime>
          <VisitEndTime>string</VisitEndTime>
          <IsMissedVisit>string</IsMissedVisit>
          <PrimaryContract>
            <ID>int</ID>
            <Name>string</Name>
          </PrimaryContract>
          <BillingServiceCode>
            <ID>int</ID>
            <Name>string</Name>
            <BillType>string</BillType>
          </BillingServiceCode>
          <BilledMinutes>int</BilledMinutes>
          <BilledAmount>decimal</BilledAmount>
          <PayrollAdjustmentMinutes>int</PayrollAdjustmentMinutes>
          <Payrolldate>string</Payrolldate>
          <RegularHours>
            <Minutes>decimal</Minutes>
            <Payrate>decimal</Payrate>
            <Amount>decimal</Amount>
            <PayCode xsi:nil="true" />
          </RegularHours>
          <OTHours>
            <Minutes>decimal</Minutes>
            <Payrate>decimal</Payrate>
            <Amount>decimal</Amount>
            <PayCode xsi:nil="true" />
          </OTHours>
          <HolidayHours>
            <Minutes>decimal</Minutes>
            <Payrate>decimal</Payrate>
            <Amount>decimal</Amount>
            <PayCode xsi:nil="true" />
          </HolidayHours>
        </VisitPayrollInfo>
      </GetVisitPayrollInfoResult>
    </GetVisitPayrollInfoResponse>
  </soap12:Body>
</soap12:Envelope>