ws Web Service

Click here for a complete list of operations.

GetCaregiverDemographics

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

<?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>
    <GetCaregiverDemographics xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverInfo>
        <ID>int</ID>
      </CaregiverInfo>
    </GetCaregiverDemographics>
  </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>
    <GetCaregiverDemographicsResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverDemographicsResult>
        <CaregiverInfo>
          <ID>int</ID>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <Intials>string</Intials>
          <Gender>string</Gender>
          <CaregiverGenderID>string</CaregiverGenderID>
          <BirthDate>string</BirthDate>
          <CaregiverCode>int</CaregiverCode>
          <TimeAndAttendancePIN>int</TimeAndAttendancePIN>
          <AlternateCaregiverCode>string</AlternateCaregiverCode>
          <MobileID>int</MobileID>
          <MobileIDType>string</MobileIDType>
          <MobileIDTypeDescription>string</MobileIDTypeDescription>
          <SSN>string</SSN>
          <Ethnicity>
            <ID>int</ID>
            <Name>string</Name>
          </Ethnicity>
          <RehireDate>string</RehireDate>
          <CountryOfBirth>string</CountryOfBirth>
          <EmployeeType>string</EmployeeType>
          <MaritalStatus>
            <ID>int</ID>
            <Name>string</Name>
          </MaritalStatus>
          <Dependents>string</Dependents>
          <Status>
            <ID>int</ID>
            <Name>string</Name>
          </Status>
          <EmploymentTypes>
            <Discipline>string</Discipline>
            <Discipline>string</Discipline>
          </EmploymentTypes>
          <EmployeeID>string</EmployeeID>
          <ApplicationDate>string</ApplicationDate>
          <Team>
            <ID>int</ID>
            <Name>string</Name>
          </Team>
          <Location>
            <ID>int</ID>
            <Name>string</Name>
          </Location>
          <Branch>
            <ID>int</ID>
            <Name>string</Name>
          </Branch>
          <HireDate>string</HireDate>
          <FirstWorkDate>string</FirstWorkDate>
          <LastWorkDate>string</LastWorkDate>
          <RegistryNumber>string</RegistryNumber>
          <RegistryCheckedDate>string</RegistryCheckedDate>
          <ReferralSource>
            <ID>int</ID>
            <Name>string</Name>
          </ReferralSource>
          <ReferralPerson>string</ReferralPerson>
          <Address>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <City>string</City>
            <State>string</State>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <HomePhone>string</HomePhone>
            <Phone2>string</Phone2>
            <Phone3>string</Phone3>
          </Address>
          <EmergencyContacts>
            <EmergencyContact xsi:nil="true" />
            <EmergencyContact xsi:nil="true" />
          </EmergencyContacts>
          <NotificationPreferences>
            <Method xsi:nil="true" />
            <Email>string</Email>
            <MobileOrSMS>string</MobileOrSMS>
            <VoiceMessage>string</VoiceMessage>
          </NotificationPreferences>
          <CaregiverOffices>
            <Office xsi:nil="true" />
            <Office xsi:nil="true" />
          </CaregiverOffices>
          <InactiveReasonID>int</InactiveReasonID>
          <InactiveReason>string</InactiveReason>
          <InactiveNote>string</InactiveNote>
          <TerminatedDate>string</TerminatedDate>
          <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
          <NPINumber>string</NPINumber>
          <SignedPayrollAgreementDate>string</SignedPayrollAgreementDate>
          <LanguageID1>int</LanguageID1>
          <Language1>string</Language1>
          <LanguageID2>int</LanguageID2>
          <Language2>string</Language2>
          <LanguageID3>int</LanguageID3>
          <Language3>string</Language3>
          <LanguageID4>int</LanguageID4>
          <Language4>string</Language4>
          <LastModifiedDate>string</LastModifiedDate>
          <TimeZone>string</TimeZone>
        </CaregiverInfo>
      </GetCaregiverDemographicsResult>
    </GetCaregiverDemographicsResponse>
  </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>
    <GetCaregiverDemographics xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverInfo>
        <ID>int</ID>
      </CaregiverInfo>
    </GetCaregiverDemographics>
  </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>
    <GetCaregiverDemographicsResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverDemographicsResult>
        <CaregiverInfo>
          <ID>int</ID>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <Intials>string</Intials>
          <Gender>string</Gender>
          <CaregiverGenderID>string</CaregiverGenderID>
          <BirthDate>string</BirthDate>
          <CaregiverCode>int</CaregiverCode>
          <TimeAndAttendancePIN>int</TimeAndAttendancePIN>
          <AlternateCaregiverCode>string</AlternateCaregiverCode>
          <MobileID>int</MobileID>
          <MobileIDType>string</MobileIDType>
          <MobileIDTypeDescription>string</MobileIDTypeDescription>
          <SSN>string</SSN>
          <Ethnicity>
            <ID>int</ID>
            <Name>string</Name>
          </Ethnicity>
          <RehireDate>string</RehireDate>
          <CountryOfBirth>string</CountryOfBirth>
          <EmployeeType>string</EmployeeType>
          <MaritalStatus>
            <ID>int</ID>
            <Name>string</Name>
          </MaritalStatus>
          <Dependents>string</Dependents>
          <Status>
            <ID>int</ID>
            <Name>string</Name>
          </Status>
          <EmploymentTypes>
            <Discipline>string</Discipline>
            <Discipline>string</Discipline>
          </EmploymentTypes>
          <EmployeeID>string</EmployeeID>
          <ApplicationDate>string</ApplicationDate>
          <Team>
            <ID>int</ID>
            <Name>string</Name>
          </Team>
          <Location>
            <ID>int</ID>
            <Name>string</Name>
          </Location>
          <Branch>
            <ID>int</ID>
            <Name>string</Name>
          </Branch>
          <HireDate>string</HireDate>
          <FirstWorkDate>string</FirstWorkDate>
          <LastWorkDate>string</LastWorkDate>
          <RegistryNumber>string</RegistryNumber>
          <RegistryCheckedDate>string</RegistryCheckedDate>
          <ReferralSource>
            <ID>int</ID>
            <Name>string</Name>
          </ReferralSource>
          <ReferralPerson>string</ReferralPerson>
          <Address>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <City>string</City>
            <State>string</State>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <HomePhone>string</HomePhone>
            <Phone2>string</Phone2>
            <Phone3>string</Phone3>
          </Address>
          <EmergencyContacts>
            <EmergencyContact xsi:nil="true" />
            <EmergencyContact xsi:nil="true" />
          </EmergencyContacts>
          <NotificationPreferences>
            <Method xsi:nil="true" />
            <Email>string</Email>
            <MobileOrSMS>string</MobileOrSMS>
            <VoiceMessage>string</VoiceMessage>
          </NotificationPreferences>
          <CaregiverOffices>
            <Office xsi:nil="true" />
            <Office xsi:nil="true" />
          </CaregiverOffices>
          <InactiveReasonID>int</InactiveReasonID>
          <InactiveReason>string</InactiveReason>
          <InactiveNote>string</InactiveNote>
          <TerminatedDate>string</TerminatedDate>
          <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
          <NPINumber>string</NPINumber>
          <SignedPayrollAgreementDate>string</SignedPayrollAgreementDate>
          <LanguageID1>int</LanguageID1>
          <Language1>string</Language1>
          <LanguageID2>int</LanguageID2>
          <Language2>string</Language2>
          <LanguageID3>int</LanguageID3>
          <Language3>string</Language3>
          <LanguageID4>int</LanguageID4>
          <Language4>string</Language4>
          <LastModifiedDate>string</LastModifiedDate>
          <TimeZone>string</TimeZone>
        </CaregiverInfo>
      </GetCaregiverDemographicsResult>
    </GetCaregiverDemographicsResponse>
  </soap12:Body>
</soap12:Envelope>