ws Web Service

Click here for a complete list of operations.

GetCaregiverChangesV2

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

<?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>
    <GetCaregiverChangesV2 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>
    </GetCaregiverChangesV2>
  </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>
    <GetCaregiverChangesV2Response xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverChangesV2Result>
        <GetCaregiverChangesV2Info>
          <AgencyID>int</AgencyID>
          <OfficeID>int</OfficeID>
          <CaregiverID>int</CaregiverID>
          <ModifiedDate>string</ModifiedDate>
          <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>
          <CaregiverMobileID>string</CaregiverMobileID>
          <CaregiverMobileIDType>string</CaregiverMobileIDType>
          <Rehire>string</Rehire>
          <RehireDate>string</RehireDate>
          <CountryOfBirth>string</CountryOfBirth>
          <MaritalStatus>string</MaritalStatus>
          <Dependents>string</Dependents>
          <EmployeeType>string</EmployeeType>
          <Status>string</Status>
          <StatusReason>int</StatusReason>
          <StatusNote>string</StatusNote>
          <TerminatedDate>string</TerminatedDate>
          <EmploymentTypes>
            <Discipline>string</Discipline>
            <Discipline>string</Discipline>
          </EmploymentTypes>
          <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>
          <SignedPayrollAgreement>string</SignedPayrollAgreement>
          <SignedPayrollAgreementDate>string</SignedPayrollAgreementDate>
          <ExclusionListCheckedOn>string</ExclusionListCheckedOn>
          <ExclusionListStatus>string</ExclusionListStatus>
          <Address>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <City>string</City>
            <State>string</State>
            <Zip5>string</Zip5>
            <Zip4>string</Zip4>
            <HomePhone>string</HomePhone>
            <Phone2>string</Phone2>
            <Phone3>string</Phone3>
          </Address>
          <EmergencyContact1>
            <Name>string</Name>
            <Address>string</Address>
            <RelationshipID>int</RelationshipID>
            <RelationshipName>string</RelationshipName>
            <RelationshipOther>string</RelationshipOther>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact1>
          <EmergencyContact2>
            <Name>string</Name>
            <Address>string</Address>
            <RelationshipID>int</RelationshipID>
            <RelationshipName>string</RelationshipName>
            <RelationshipOther>string</RelationshipOther>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact2>
          <NotificationPreferences>
            <MethodID>int</MethodID>
            <Email>string</Email>
            <MobileOrSMS>string</MobileOrSMS>
            <VoiceMessage>string</VoiceMessage>
          </NotificationPreferences>
          <HireDate>string</HireDate>
          <I9ABDocumentID>int</I9ABDocumentID>
          <I9CDocumentID>int</I9CDocumentID>
          <I9Verified>string</I9Verified>
          <I9DocumentExpiration>string</I9DocumentExpiration>
          <I9Notes>string</I9Notes>
          <I9EVerifyNumber>string</I9EVerifyNumber>
          <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
          <NPInumber>string</NPInumber>
          <Language1>int</Language1>
          <Language2>int</Language2>
          <Language3>int</Language3>
          <Language4>int</Language4>
          <Other>string</Other>
          <FirstWorkDate>string</FirstWorkDate>
          <LastWorkDate>string</LastWorkDate>
          <TimeZone>string</TimeZone>
        </GetCaregiverChangesV2Info>
        <GetCaregiverChangesV2Info>
          <AgencyID>int</AgencyID>
          <OfficeID>int</OfficeID>
          <CaregiverID>int</CaregiverID>
          <ModifiedDate>string</ModifiedDate>
          <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>
          <CaregiverMobileID>string</CaregiverMobileID>
          <CaregiverMobileIDType>string</CaregiverMobileIDType>
          <Rehire>string</Rehire>
          <RehireDate>string</RehireDate>
          <CountryOfBirth>string</CountryOfBirth>
          <MaritalStatus>string</MaritalStatus>
          <Dependents>string</Dependents>
          <EmployeeType>string</EmployeeType>
          <Status>string</Status>
          <StatusReason>int</StatusReason>
          <StatusNote>string</StatusNote>
          <TerminatedDate>string</TerminatedDate>
          <EmploymentTypes>
            <Discipline>string</Discipline>
            <Discipline>string</Discipline>
          </EmploymentTypes>
          <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>
          <SignedPayrollAgreement>string</SignedPayrollAgreement>
          <SignedPayrollAgreementDate>string</SignedPayrollAgreementDate>
          <ExclusionListCheckedOn>string</ExclusionListCheckedOn>
          <ExclusionListStatus>string</ExclusionListStatus>
          <Address>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <City>string</City>
            <State>string</State>
            <Zip5>string</Zip5>
            <Zip4>string</Zip4>
            <HomePhone>string</HomePhone>
            <Phone2>string</Phone2>
            <Phone3>string</Phone3>
          </Address>
          <EmergencyContact1>
            <Name>string</Name>
            <Address>string</Address>
            <RelationshipID>int</RelationshipID>
            <RelationshipName>string</RelationshipName>
            <RelationshipOther>string</RelationshipOther>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact1>
          <EmergencyContact2>
            <Name>string</Name>
            <Address>string</Address>
            <RelationshipID>int</RelationshipID>
            <RelationshipName>string</RelationshipName>
            <RelationshipOther>string</RelationshipOther>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact2>
          <NotificationPreferences>
            <MethodID>int</MethodID>
            <Email>string</Email>
            <MobileOrSMS>string</MobileOrSMS>
            <VoiceMessage>string</VoiceMessage>
          </NotificationPreferences>
          <HireDate>string</HireDate>
          <I9ABDocumentID>int</I9ABDocumentID>
          <I9CDocumentID>int</I9CDocumentID>
          <I9Verified>string</I9Verified>
          <I9DocumentExpiration>string</I9DocumentExpiration>
          <I9Notes>string</I9Notes>
          <I9EVerifyNumber>string</I9EVerifyNumber>
          <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
          <NPInumber>string</NPInumber>
          <Language1>int</Language1>
          <Language2>int</Language2>
          <Language3>int</Language3>
          <Language4>int</Language4>
          <Other>string</Other>
          <FirstWorkDate>string</FirstWorkDate>
          <LastWorkDate>string</LastWorkDate>
          <TimeZone>string</TimeZone>
        </GetCaregiverChangesV2Info>
      </GetCaregiverChangesV2Result>
    </GetCaregiverChangesV2Response>
  </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>
    <GetCaregiverChangesV2 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>
    </GetCaregiverChangesV2>
  </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>
    <GetCaregiverChangesV2Response xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverChangesV2Result>
        <GetCaregiverChangesV2Info>
          <AgencyID>int</AgencyID>
          <OfficeID>int</OfficeID>
          <CaregiverID>int</CaregiverID>
          <ModifiedDate>string</ModifiedDate>
          <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>
          <CaregiverMobileID>string</CaregiverMobileID>
          <CaregiverMobileIDType>string</CaregiverMobileIDType>
          <Rehire>string</Rehire>
          <RehireDate>string</RehireDate>
          <CountryOfBirth>string</CountryOfBirth>
          <MaritalStatus>string</MaritalStatus>
          <Dependents>string</Dependents>
          <EmployeeType>string</EmployeeType>
          <Status>string</Status>
          <StatusReason>int</StatusReason>
          <StatusNote>string</StatusNote>
          <TerminatedDate>string</TerminatedDate>
          <EmploymentTypes>
            <Discipline>string</Discipline>
            <Discipline>string</Discipline>
          </EmploymentTypes>
          <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>
          <SignedPayrollAgreement>string</SignedPayrollAgreement>
          <SignedPayrollAgreementDate>string</SignedPayrollAgreementDate>
          <ExclusionListCheckedOn>string</ExclusionListCheckedOn>
          <ExclusionListStatus>string</ExclusionListStatus>
          <Address>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <City>string</City>
            <State>string</State>
            <Zip5>string</Zip5>
            <Zip4>string</Zip4>
            <HomePhone>string</HomePhone>
            <Phone2>string</Phone2>
            <Phone3>string</Phone3>
          </Address>
          <EmergencyContact1>
            <Name>string</Name>
            <Address>string</Address>
            <RelationshipID>int</RelationshipID>
            <RelationshipName>string</RelationshipName>
            <RelationshipOther>string</RelationshipOther>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact1>
          <EmergencyContact2>
            <Name>string</Name>
            <Address>string</Address>
            <RelationshipID>int</RelationshipID>
            <RelationshipName>string</RelationshipName>
            <RelationshipOther>string</RelationshipOther>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact2>
          <NotificationPreferences>
            <MethodID>int</MethodID>
            <Email>string</Email>
            <MobileOrSMS>string</MobileOrSMS>
            <VoiceMessage>string</VoiceMessage>
          </NotificationPreferences>
          <HireDate>string</HireDate>
          <I9ABDocumentID>int</I9ABDocumentID>
          <I9CDocumentID>int</I9CDocumentID>
          <I9Verified>string</I9Verified>
          <I9DocumentExpiration>string</I9DocumentExpiration>
          <I9Notes>string</I9Notes>
          <I9EVerifyNumber>string</I9EVerifyNumber>
          <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
          <NPInumber>string</NPInumber>
          <Language1>int</Language1>
          <Language2>int</Language2>
          <Language3>int</Language3>
          <Language4>int</Language4>
          <Other>string</Other>
          <FirstWorkDate>string</FirstWorkDate>
          <LastWorkDate>string</LastWorkDate>
          <TimeZone>string</TimeZone>
        </GetCaregiverChangesV2Info>
        <GetCaregiverChangesV2Info>
          <AgencyID>int</AgencyID>
          <OfficeID>int</OfficeID>
          <CaregiverID>int</CaregiverID>
          <ModifiedDate>string</ModifiedDate>
          <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>
          <CaregiverMobileID>string</CaregiverMobileID>
          <CaregiverMobileIDType>string</CaregiverMobileIDType>
          <Rehire>string</Rehire>
          <RehireDate>string</RehireDate>
          <CountryOfBirth>string</CountryOfBirth>
          <MaritalStatus>string</MaritalStatus>
          <Dependents>string</Dependents>
          <EmployeeType>string</EmployeeType>
          <Status>string</Status>
          <StatusReason>int</StatusReason>
          <StatusNote>string</StatusNote>
          <TerminatedDate>string</TerminatedDate>
          <EmploymentTypes>
            <Discipline>string</Discipline>
            <Discipline>string</Discipline>
          </EmploymentTypes>
          <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>
          <SignedPayrollAgreement>string</SignedPayrollAgreement>
          <SignedPayrollAgreementDate>string</SignedPayrollAgreementDate>
          <ExclusionListCheckedOn>string</ExclusionListCheckedOn>
          <ExclusionListStatus>string</ExclusionListStatus>
          <Address>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <City>string</City>
            <State>string</State>
            <Zip5>string</Zip5>
            <Zip4>string</Zip4>
            <HomePhone>string</HomePhone>
            <Phone2>string</Phone2>
            <Phone3>string</Phone3>
          </Address>
          <EmergencyContact1>
            <Name>string</Name>
            <Address>string</Address>
            <RelationshipID>int</RelationshipID>
            <RelationshipName>string</RelationshipName>
            <RelationshipOther>string</RelationshipOther>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact1>
          <EmergencyContact2>
            <Name>string</Name>
            <Address>string</Address>
            <RelationshipID>int</RelationshipID>
            <RelationshipName>string</RelationshipName>
            <RelationshipOther>string</RelationshipOther>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact2>
          <NotificationPreferences>
            <MethodID>int</MethodID>
            <Email>string</Email>
            <MobileOrSMS>string</MobileOrSMS>
            <VoiceMessage>string</VoiceMessage>
          </NotificationPreferences>
          <HireDate>string</HireDate>
          <I9ABDocumentID>int</I9ABDocumentID>
          <I9CDocumentID>int</I9CDocumentID>
          <I9Verified>string</I9Verified>
          <I9DocumentExpiration>string</I9DocumentExpiration>
          <I9Notes>string</I9Notes>
          <I9EVerifyNumber>string</I9EVerifyNumber>
          <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
          <NPInumber>string</NPInumber>
          <Language1>int</Language1>
          <Language2>int</Language2>
          <Language3>int</Language3>
          <Language4>int</Language4>
          <Other>string</Other>
          <FirstWorkDate>string</FirstWorkDate>
          <LastWorkDate>string</LastWorkDate>
          <TimeZone>string</TimeZone>
        </GetCaregiverChangesV2Info>
      </GetCaregiverChangesV2Result>
    </GetCaregiverChangesV2Response>
  </soap12:Body>
</soap12:Envelope>