ws Web Service

Click here for a complete list of operations.

GetCaregiverPayrollInfoChanges

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

<?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>
    <GetCaregiverPayrollInfoChanges xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <OfficeID>int</OfficeID>
      <ModifiedAfter>dateTime</ModifiedAfter>
      <LastChangeSeq>int</LastChangeSeq>
    </GetCaregiverPayrollInfoChanges>
  </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>
    <GetCaregiverPayrollInfoChangesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverPayrollInfoChangesResult>
        <PayrollInfoChanges>
          <PayrollInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <CaregiverID>int</CaregiverID>
            <ModifiedDate>string</ModifiedDate>
            <ChangeSequenceNumber>long</ChangeSequenceNumber>
            <Action>string</Action>
            <CoCode>string</CoCode>
            <RateType>string</RateType>
            <PensionProfitSharing>string</PensionProfitSharing>
            <ExemptionFromOvertime>string</ExemptionFromOvertime>
            <DirectDeposit>string</DirectDeposit>
            <NycResident>string</NycResident>
            <Is1099>string</Is1099>
            <UnionReduction>string</UnionReduction>
            <MedicalDeductionCode>string</MedicalDeductionCode>
            <PayCycle>int</PayCycle>
            <CityTax>int</CityTax>
            <CostCenter1>int</CostCenter1>
            <CostCenter2>int</CostCenter2>
            <CostCenter3>int</CostCenter3>
            <CostCenter4>int</CostCenter4>
            <CostCenter5>int</CostCenter5>
            <TaxTypes>int</TaxTypes>
            <TaxLocation>int</TaxLocation>
            <StateFillingStatus>int</StateFillingStatus>
            <FederalFillingStatus>int</FederalFillingStatus>
            <FederalMaritalStatus>int</FederalMaritalStatus>
            <FederalExemptions>int</FederalExemptions>
            <StateMaritalStatus>int</StateMaritalStatus>
            <StateExemptions>decimal</StateExemptions>
            <BaseRate>decimal</BaseRate>
          </PayrollInfo>
          <PayrollInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <CaregiverID>int</CaregiverID>
            <ModifiedDate>string</ModifiedDate>
            <ChangeSequenceNumber>long</ChangeSequenceNumber>
            <Action>string</Action>
            <CoCode>string</CoCode>
            <RateType>string</RateType>
            <PensionProfitSharing>string</PensionProfitSharing>
            <ExemptionFromOvertime>string</ExemptionFromOvertime>
            <DirectDeposit>string</DirectDeposit>
            <NycResident>string</NycResident>
            <Is1099>string</Is1099>
            <UnionReduction>string</UnionReduction>
            <MedicalDeductionCode>string</MedicalDeductionCode>
            <PayCycle>int</PayCycle>
            <CityTax>int</CityTax>
            <CostCenter1>int</CostCenter1>
            <CostCenter2>int</CostCenter2>
            <CostCenter3>int</CostCenter3>
            <CostCenter4>int</CostCenter4>
            <CostCenter5>int</CostCenter5>
            <TaxTypes>int</TaxTypes>
            <TaxLocation>int</TaxLocation>
            <StateFillingStatus>int</StateFillingStatus>
            <FederalFillingStatus>int</FederalFillingStatus>
            <FederalMaritalStatus>int</FederalMaritalStatus>
            <FederalExemptions>int</FederalExemptions>
            <StateMaritalStatus>int</StateMaritalStatus>
            <StateExemptions>decimal</StateExemptions>
            <BaseRate>decimal</BaseRate>
          </PayrollInfo>
        </PayrollInfoChanges>
      </GetCaregiverPayrollInfoChangesResult>
    </GetCaregiverPayrollInfoChangesResponse>
  </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>
    <GetCaregiverPayrollInfoChanges xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <OfficeID>int</OfficeID>
      <ModifiedAfter>dateTime</ModifiedAfter>
      <LastChangeSeq>int</LastChangeSeq>
    </GetCaregiverPayrollInfoChanges>
  </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>
    <GetCaregiverPayrollInfoChangesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverPayrollInfoChangesResult>
        <PayrollInfoChanges>
          <PayrollInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <CaregiverID>int</CaregiverID>
            <ModifiedDate>string</ModifiedDate>
            <ChangeSequenceNumber>long</ChangeSequenceNumber>
            <Action>string</Action>
            <CoCode>string</CoCode>
            <RateType>string</RateType>
            <PensionProfitSharing>string</PensionProfitSharing>
            <ExemptionFromOvertime>string</ExemptionFromOvertime>
            <DirectDeposit>string</DirectDeposit>
            <NycResident>string</NycResident>
            <Is1099>string</Is1099>
            <UnionReduction>string</UnionReduction>
            <MedicalDeductionCode>string</MedicalDeductionCode>
            <PayCycle>int</PayCycle>
            <CityTax>int</CityTax>
            <CostCenter1>int</CostCenter1>
            <CostCenter2>int</CostCenter2>
            <CostCenter3>int</CostCenter3>
            <CostCenter4>int</CostCenter4>
            <CostCenter5>int</CostCenter5>
            <TaxTypes>int</TaxTypes>
            <TaxLocation>int</TaxLocation>
            <StateFillingStatus>int</StateFillingStatus>
            <FederalFillingStatus>int</FederalFillingStatus>
            <FederalMaritalStatus>int</FederalMaritalStatus>
            <FederalExemptions>int</FederalExemptions>
            <StateMaritalStatus>int</StateMaritalStatus>
            <StateExemptions>decimal</StateExemptions>
            <BaseRate>decimal</BaseRate>
          </PayrollInfo>
          <PayrollInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <CaregiverID>int</CaregiverID>
            <ModifiedDate>string</ModifiedDate>
            <ChangeSequenceNumber>long</ChangeSequenceNumber>
            <Action>string</Action>
            <CoCode>string</CoCode>
            <RateType>string</RateType>
            <PensionProfitSharing>string</PensionProfitSharing>
            <ExemptionFromOvertime>string</ExemptionFromOvertime>
            <DirectDeposit>string</DirectDeposit>
            <NycResident>string</NycResident>
            <Is1099>string</Is1099>
            <UnionReduction>string</UnionReduction>
            <MedicalDeductionCode>string</MedicalDeductionCode>
            <PayCycle>int</PayCycle>
            <CityTax>int</CityTax>
            <CostCenter1>int</CostCenter1>
            <CostCenter2>int</CostCenter2>
            <CostCenter3>int</CostCenter3>
            <CostCenter4>int</CostCenter4>
            <CostCenter5>int</CostCenter5>
            <TaxTypes>int</TaxTypes>
            <TaxLocation>int</TaxLocation>
            <StateFillingStatus>int</StateFillingStatus>
            <FederalFillingStatus>int</FederalFillingStatus>
            <FederalMaritalStatus>int</FederalMaritalStatus>
            <FederalExemptions>int</FederalExemptions>
            <StateMaritalStatus>int</StateMaritalStatus>
            <StateExemptions>decimal</StateExemptions>
            <BaseRate>decimal</BaseRate>
          </PayrollInfo>
        </PayrollInfoChanges>
      </GetCaregiverPayrollInfoChangesResult>
    </GetCaregiverPayrollInfoChangesResponse>
  </soap12:Body>
</soap12:Envelope>