ws

Click here for a complete list of operations.

GetCaregiverChanges

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

<?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>
    <GetCaregiverChanges 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>
    </GetCaregiverChanges>
  </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>
    <GetCaregiverChangesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverChangesResult>
        <CaregiverChanges>
          <CaregiverInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <CaregiverID>int</CaregiverID>
            <ModifiedDate>string</ModifiedDate>
            <ChangeSequenceNumber>long</ChangeSequenceNumber>
            <Action>string</Action>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <Initials>string</Initials>
            <Gender>string</Gender>
            <DateofBirth>string</DateofBirth>
            <CaregiverCode>string</CaregiverCode>
            <AlternateCaregiverCode>string</AlternateCaregiverCode>
            <TimeAndAttendancePIN>string</TimeAndAttendancePIN>
            <SSN>string</SSN>
            <Ethnicity>string</Ethnicity>
            <RehireDate>string</RehireDate>
            <CountryOfBirth>string</CountryOfBirth>
            <MaritalStatus>string</MaritalStatus>
            <Dependents>string</Dependents>
            <EmployeeType>string</EmployeeType>
            <Status>string</Status>
            <InActiveReason>int</InActiveReason>
            <InActiveNote>string</InActiveNote>
            <TerminatedDate>string</TerminatedDate>
            <EmploymentTypes xsi:nil="true" />
            <Sent105>string</Sent105>
            <EmployeeID>string</EmployeeID>
            <ApplicationDate>string</ApplicationDate>
            <TeamID>int</TeamID>
            <LocationID>int</LocationID>
            <BranchID>int</BranchID>
            <Payer>string</Payer>
            <Registrynumber>string</Registrynumber>
            <RegistryDate>string</RegistryDate>
            <ReferralSourceID>int</ReferralSourceID>
            <ReferralPerson>string</ReferralPerson>
            <NYCRegistryCheckedOn>string</NYCRegistryCheckedOn>
            <NYCRegistryCheckedDate>string</NYCRegistryCheckedDate>
            <ExclusionListCheckedOn>string</ExclusionListCheckedOn>
            <ExclusionListStatus>string</ExclusionListStatus>
            <Address xsi:nil="true" />
            <EmergencyContact1 xsi:nil="true" />
            <EmergencyContact2 xsi:nil="true" />
            <NotificationPreferences xsi:nil="true" />
            <HireDate>string</HireDate>
            <I9DocumentID>int</I9DocumentID>
            <I9Document2>string</I9Document2>
            <I9ExpirationDate>string</I9ExpirationDate>
            <I9Vefified>string</I9Vefified>
            <I9Comments>string</I9Comments>
            <Reference1>string</Reference1>
            <Reference2>string</Reference2>
            <Degree>string</Degree>
            <CriminalBackgroundDate1>string</CriminalBackgroundDate1>
            <CriminalBackgroundResult1>string</CriminalBackgroundResult1>
            <CriminalBackgroundReceivedDate1>string</CriminalBackgroundReceivedDate1>
            <CriminalBackgroundDate2>string</CriminalBackgroundDate2>
            <CriminalBackgroundResult2>string</CriminalBackgroundResult2>
            <CriminalBackgroundReceivedDate2>string</CriminalBackgroundReceivedDate2>
            <CriminalBackgroundDate3>string</CriminalBackgroundDate3>
            <CriminalBackgroundResult3>string</CriminalBackgroundResult3>
            <CriminalBackgroundReceivedDate3>string</CriminalBackgroundReceivedDate3>
            <LastEmploymentAgency>string</LastEmploymentAgency>
            <LastEmploymentStartDate>string</LastEmploymentStartDate>
            <LastEmploymentEndDate>string</LastEmploymentEndDate>
            <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
            <Licensedateverified>string</Licensedateverified>
            <ProfessionalRegistrationExpirationDate>string</ProfessionalRegistrationExpirationDate>
            <AutomobileInsuranceExpirationDate>string</AutomobileInsuranceExpirationDate>
            <NoCar>string</NoCar>
            <MalpracticeInsuranceExpirationDate>string</MalpracticeInsuranceExpirationDate>
            <CPRVerifiedon>string</CPRVerifiedon>
            <PICCCertificationDateVerified>string</PICCCertificationDateVerified>
            <NPInumber>string</NPInumber>
            <Language1>int</Language1>
            <Language2>int</Language2>
            <Language3>int</Language3>
            <Language4>int</Language4>
            <Other>string</Other>
            <CoCode>string</CoCode>
            <FedExemption>string</FedExemption>
            <RateType>string</RateType>
            <PensionProfitSharing>string</PensionProfitSharing>
            <ExemptionFromOvertime>string</ExemptionFromOvertime>
            <DirectDeposit>string</DirectDeposit>
            <NycResident>string</NycResident>
            <Employee1099>string</Employee1099>
            <UnionReduction>string</UnionReduction>
            <MedicalDeductionCode>string</MedicalDeductionCode>
            <PayCycle>string</PayCycle>
          </CaregiverInfo>
          <CaregiverInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <CaregiverID>int</CaregiverID>
            <ModifiedDate>string</ModifiedDate>
            <ChangeSequenceNumber>long</ChangeSequenceNumber>
            <Action>string</Action>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <Initials>string</Initials>
            <Gender>string</Gender>
            <DateofBirth>string</DateofBirth>
            <CaregiverCode>string</CaregiverCode>
            <AlternateCaregiverCode>string</AlternateCaregiverCode>
            <TimeAndAttendancePIN>string</TimeAndAttendancePIN>
            <SSN>string</SSN>
            <Ethnicity>string</Ethnicity>
            <RehireDate>string</RehireDate>
            <CountryOfBirth>string</CountryOfBirth>
            <MaritalStatus>string</MaritalStatus>
            <Dependents>string</Dependents>
            <EmployeeType>string</EmployeeType>
            <Status>string</Status>
            <InActiveReason>int</InActiveReason>
            <InActiveNote>string</InActiveNote>
            <TerminatedDate>string</TerminatedDate>
            <EmploymentTypes xsi:nil="true" />
            <Sent105>string</Sent105>
            <EmployeeID>string</EmployeeID>
            <ApplicationDate>string</ApplicationDate>
            <TeamID>int</TeamID>
            <LocationID>int</LocationID>
            <BranchID>int</BranchID>
            <Payer>string</Payer>
            <Registrynumber>string</Registrynumber>
            <RegistryDate>string</RegistryDate>
            <ReferralSourceID>int</ReferralSourceID>
            <ReferralPerson>string</ReferralPerson>
            <NYCRegistryCheckedOn>string</NYCRegistryCheckedOn>
            <NYCRegistryCheckedDate>string</NYCRegistryCheckedDate>
            <ExclusionListCheckedOn>string</ExclusionListCheckedOn>
            <ExclusionListStatus>string</ExclusionListStatus>
            <Address xsi:nil="true" />
            <EmergencyContact1 xsi:nil="true" />
            <EmergencyContact2 xsi:nil="true" />
            <NotificationPreferences xsi:nil="true" />
            <HireDate>string</HireDate>
            <I9DocumentID>int</I9DocumentID>
            <I9Document2>string</I9Document2>
            <I9ExpirationDate>string</I9ExpirationDate>
            <I9Vefified>string</I9Vefified>
            <I9Comments>string</I9Comments>
            <Reference1>string</Reference1>
            <Reference2>string</Reference2>
            <Degree>string</Degree>
            <CriminalBackgroundDate1>string</CriminalBackgroundDate1>
            <CriminalBackgroundResult1>string</CriminalBackgroundResult1>
            <CriminalBackgroundReceivedDate1>string</CriminalBackgroundReceivedDate1>
            <CriminalBackgroundDate2>string</CriminalBackgroundDate2>
            <CriminalBackgroundResult2>string</CriminalBackgroundResult2>
            <CriminalBackgroundReceivedDate2>string</CriminalBackgroundReceivedDate2>
            <CriminalBackgroundDate3>string</CriminalBackgroundDate3>
            <CriminalBackgroundResult3>string</CriminalBackgroundResult3>
            <CriminalBackgroundReceivedDate3>string</CriminalBackgroundReceivedDate3>
            <LastEmploymentAgency>string</LastEmploymentAgency>
            <LastEmploymentStartDate>string</LastEmploymentStartDate>
            <LastEmploymentEndDate>string</LastEmploymentEndDate>
            <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
            <Licensedateverified>string</Licensedateverified>
            <ProfessionalRegistrationExpirationDate>string</ProfessionalRegistrationExpirationDate>
            <AutomobileInsuranceExpirationDate>string</AutomobileInsuranceExpirationDate>
            <NoCar>string</NoCar>
            <MalpracticeInsuranceExpirationDate>string</MalpracticeInsuranceExpirationDate>
            <CPRVerifiedon>string</CPRVerifiedon>
            <PICCCertificationDateVerified>string</PICCCertificationDateVerified>
            <NPInumber>string</NPInumber>
            <Language1>int</Language1>
            <Language2>int</Language2>
            <Language3>int</Language3>
            <Language4>int</Language4>
            <Other>string</Other>
            <CoCode>string</CoCode>
            <FedExemption>string</FedExemption>
            <RateType>string</RateType>
            <PensionProfitSharing>string</PensionProfitSharing>
            <ExemptionFromOvertime>string</ExemptionFromOvertime>
            <DirectDeposit>string</DirectDeposit>
            <NycResident>string</NycResident>
            <Employee1099>string</Employee1099>
            <UnionReduction>string</UnionReduction>
            <MedicalDeductionCode>string</MedicalDeductionCode>
            <PayCycle>string</PayCycle>
          </CaregiverInfo>
        </CaregiverChanges>
      </GetCaregiverChangesResult>
    </GetCaregiverChangesResponse>
  </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>
    <GetCaregiverChanges 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>
    </GetCaregiverChanges>
  </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>
    <GetCaregiverChangesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverChangesResult>
        <CaregiverChanges>
          <CaregiverInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <CaregiverID>int</CaregiverID>
            <ModifiedDate>string</ModifiedDate>
            <ChangeSequenceNumber>long</ChangeSequenceNumber>
            <Action>string</Action>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <Initials>string</Initials>
            <Gender>string</Gender>
            <DateofBirth>string</DateofBirth>
            <CaregiverCode>string</CaregiverCode>
            <AlternateCaregiverCode>string</AlternateCaregiverCode>
            <TimeAndAttendancePIN>string</TimeAndAttendancePIN>
            <SSN>string</SSN>
            <Ethnicity>string</Ethnicity>
            <RehireDate>string</RehireDate>
            <CountryOfBirth>string</CountryOfBirth>
            <MaritalStatus>string</MaritalStatus>
            <Dependents>string</Dependents>
            <EmployeeType>string</EmployeeType>
            <Status>string</Status>
            <InActiveReason>int</InActiveReason>
            <InActiveNote>string</InActiveNote>
            <TerminatedDate>string</TerminatedDate>
            <EmploymentTypes xsi:nil="true" />
            <Sent105>string</Sent105>
            <EmployeeID>string</EmployeeID>
            <ApplicationDate>string</ApplicationDate>
            <TeamID>int</TeamID>
            <LocationID>int</LocationID>
            <BranchID>int</BranchID>
            <Payer>string</Payer>
            <Registrynumber>string</Registrynumber>
            <RegistryDate>string</RegistryDate>
            <ReferralSourceID>int</ReferralSourceID>
            <ReferralPerson>string</ReferralPerson>
            <NYCRegistryCheckedOn>string</NYCRegistryCheckedOn>
            <NYCRegistryCheckedDate>string</NYCRegistryCheckedDate>
            <ExclusionListCheckedOn>string</ExclusionListCheckedOn>
            <ExclusionListStatus>string</ExclusionListStatus>
            <Address xsi:nil="true" />
            <EmergencyContact1 xsi:nil="true" />
            <EmergencyContact2 xsi:nil="true" />
            <NotificationPreferences xsi:nil="true" />
            <HireDate>string</HireDate>
            <I9DocumentID>int</I9DocumentID>
            <I9Document2>string</I9Document2>
            <I9ExpirationDate>string</I9ExpirationDate>
            <I9Vefified>string</I9Vefified>
            <I9Comments>string</I9Comments>
            <Reference1>string</Reference1>
            <Reference2>string</Reference2>
            <Degree>string</Degree>
            <CriminalBackgroundDate1>string</CriminalBackgroundDate1>
            <CriminalBackgroundResult1>string</CriminalBackgroundResult1>
            <CriminalBackgroundReceivedDate1>string</CriminalBackgroundReceivedDate1>
            <CriminalBackgroundDate2>string</CriminalBackgroundDate2>
            <CriminalBackgroundResult2>string</CriminalBackgroundResult2>
            <CriminalBackgroundReceivedDate2>string</CriminalBackgroundReceivedDate2>
            <CriminalBackgroundDate3>string</CriminalBackgroundDate3>
            <CriminalBackgroundResult3>string</CriminalBackgroundResult3>
            <CriminalBackgroundReceivedDate3>string</CriminalBackgroundReceivedDate3>
            <LastEmploymentAgency>string</LastEmploymentAgency>
            <LastEmploymentStartDate>string</LastEmploymentStartDate>
            <LastEmploymentEndDate>string</LastEmploymentEndDate>
            <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
            <Licensedateverified>string</Licensedateverified>
            <ProfessionalRegistrationExpirationDate>string</ProfessionalRegistrationExpirationDate>
            <AutomobileInsuranceExpirationDate>string</AutomobileInsuranceExpirationDate>
            <NoCar>string</NoCar>
            <MalpracticeInsuranceExpirationDate>string</MalpracticeInsuranceExpirationDate>
            <CPRVerifiedon>string</CPRVerifiedon>
            <PICCCertificationDateVerified>string</PICCCertificationDateVerified>
            <NPInumber>string</NPInumber>
            <Language1>int</Language1>
            <Language2>int</Language2>
            <Language3>int</Language3>
            <Language4>int</Language4>
            <Other>string</Other>
            <CoCode>string</CoCode>
            <FedExemption>string</FedExemption>
            <RateType>string</RateType>
            <PensionProfitSharing>string</PensionProfitSharing>
            <ExemptionFromOvertime>string</ExemptionFromOvertime>
            <DirectDeposit>string</DirectDeposit>
            <NycResident>string</NycResident>
            <Employee1099>string</Employee1099>
            <UnionReduction>string</UnionReduction>
            <MedicalDeductionCode>string</MedicalDeductionCode>
            <PayCycle>string</PayCycle>
          </CaregiverInfo>
          <CaregiverInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <CaregiverID>int</CaregiverID>
            <ModifiedDate>string</ModifiedDate>
            <ChangeSequenceNumber>long</ChangeSequenceNumber>
            <Action>string</Action>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <Initials>string</Initials>
            <Gender>string</Gender>
            <DateofBirth>string</DateofBirth>
            <CaregiverCode>string</CaregiverCode>
            <AlternateCaregiverCode>string</AlternateCaregiverCode>
            <TimeAndAttendancePIN>string</TimeAndAttendancePIN>
            <SSN>string</SSN>
            <Ethnicity>string</Ethnicity>
            <RehireDate>string</RehireDate>
            <CountryOfBirth>string</CountryOfBirth>
            <MaritalStatus>string</MaritalStatus>
            <Dependents>string</Dependents>
            <EmployeeType>string</EmployeeType>
            <Status>string</Status>
            <InActiveReason>int</InActiveReason>
            <InActiveNote>string</InActiveNote>
            <TerminatedDate>string</TerminatedDate>
            <EmploymentTypes xsi:nil="true" />
            <Sent105>string</Sent105>
            <EmployeeID>string</EmployeeID>
            <ApplicationDate>string</ApplicationDate>
            <TeamID>int</TeamID>
            <LocationID>int</LocationID>
            <BranchID>int</BranchID>
            <Payer>string</Payer>
            <Registrynumber>string</Registrynumber>
            <RegistryDate>string</RegistryDate>
            <ReferralSourceID>int</ReferralSourceID>
            <ReferralPerson>string</ReferralPerson>
            <NYCRegistryCheckedOn>string</NYCRegistryCheckedOn>
            <NYCRegistryCheckedDate>string</NYCRegistryCheckedDate>
            <ExclusionListCheckedOn>string</ExclusionListCheckedOn>
            <ExclusionListStatus>string</ExclusionListStatus>
            <Address xsi:nil="true" />
            <EmergencyContact1 xsi:nil="true" />
            <EmergencyContact2 xsi:nil="true" />
            <NotificationPreferences xsi:nil="true" />
            <HireDate>string</HireDate>
            <I9DocumentID>int</I9DocumentID>
            <I9Document2>string</I9Document2>
            <I9ExpirationDate>string</I9ExpirationDate>
            <I9Vefified>string</I9Vefified>
            <I9Comments>string</I9Comments>
            <Reference1>string</Reference1>
            <Reference2>string</Reference2>
            <Degree>string</Degree>
            <CriminalBackgroundDate1>string</CriminalBackgroundDate1>
            <CriminalBackgroundResult1>string</CriminalBackgroundResult1>
            <CriminalBackgroundReceivedDate1>string</CriminalBackgroundReceivedDate1>
            <CriminalBackgroundDate2>string</CriminalBackgroundDate2>
            <CriminalBackgroundResult2>string</CriminalBackgroundResult2>
            <CriminalBackgroundReceivedDate2>string</CriminalBackgroundReceivedDate2>
            <CriminalBackgroundDate3>string</CriminalBackgroundDate3>
            <CriminalBackgroundResult3>string</CriminalBackgroundResult3>
            <CriminalBackgroundReceivedDate3>string</CriminalBackgroundReceivedDate3>
            <LastEmploymentAgency>string</LastEmploymentAgency>
            <LastEmploymentStartDate>string</LastEmploymentStartDate>
            <LastEmploymentEndDate>string</LastEmploymentEndDate>
            <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
            <Licensedateverified>string</Licensedateverified>
            <ProfessionalRegistrationExpirationDate>string</ProfessionalRegistrationExpirationDate>
            <AutomobileInsuranceExpirationDate>string</AutomobileInsuranceExpirationDate>
            <NoCar>string</NoCar>
            <MalpracticeInsuranceExpirationDate>string</MalpracticeInsuranceExpirationDate>
            <CPRVerifiedon>string</CPRVerifiedon>
            <PICCCertificationDateVerified>string</PICCCertificationDateVerified>
            <NPInumber>string</NPInumber>
            <Language1>int</Language1>
            <Language2>int</Language2>
            <Language3>int</Language3>
            <Language4>int</Language4>
            <Other>string</Other>
            <CoCode>string</CoCode>
            <FedExemption>string</FedExemption>
            <RateType>string</RateType>
            <PensionProfitSharing>string</PensionProfitSharing>
            <ExemptionFromOvertime>string</ExemptionFromOvertime>
            <DirectDeposit>string</DirectDeposit>
            <NycResident>string</NycResident>
            <Employee1099>string</Employee1099>
            <UnionReduction>string</UnionReduction>
            <MedicalDeductionCode>string</MedicalDeductionCode>
            <PayCycle>string</PayCycle>
          </CaregiverInfo>
        </CaregiverChanges>
      </GetCaregiverChangesResult>
    </GetCaregiverChangesResponse>
  </soap12:Body>
</soap12:Envelope>