ws Web Service

Click here for a complete list of operations.

CreateCaregiver

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

<?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>
    <CreateCaregiver xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverInfo>
        <OfficeID>int</OfficeID>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <Initials>string</Initials>
        <Gender>string</Gender>
        <Dependents>string</Dependents>
        <BirthDate>dateTime</BirthDate>
        <CaregiverCode>int</CaregiverCode>
        <AlternateCaregiverCode>string</AlternateCaregiverCode>
        <MobileID>int</MobileID>
        <MobileIDType>string</MobileIDType>
        <SSN>string</SSN>
        <EthnicityID>int</EthnicityID>
        <RehireDate>dateTime</RehireDate>
        <CountryOfBirth>string</CountryOfBirth>
        <MaritalStatus>string</MaritalStatus>
        <StatusID>int</StatusID>
        <EmploymentTypes>
          <Discipline>string</Discipline>
          <Discipline>string</Discipline>
        </EmploymentTypes>
        <EmployeeID>string</EmployeeID>
        <ApplicationDate>dateTime</ApplicationDate>
        <TeamID>int</TeamID>
        <BranchID>int</BranchID>
        <LocationID>int</LocationID>
        <HHAPCARegistryNumber>string</HHAPCARegistryNumber>
        <HHAPCARegistryCheckedDate>dateTime</HHAPCARegistryCheckedDate>
        <NYCRegistryCheckedDate>dateTime</NYCRegistryCheckedDate>
        <ReferralSourceID>int</ReferralSourceID>
        <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>
            <Name>string</Name>
            <RelationshipID>int</RelationshipID>
            <OtherRelationship>string</OtherRelationship>
            <Address>string</Address>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact>
          <EmergencyContact>
            <Name>string</Name>
            <RelationshipID>int</RelationshipID>
            <OtherRelationship>string</OtherRelationship>
            <Address>string</Address>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact>
        </EmergencyContacts>
        <NotificationPreferences>
          <MethodID>int</MethodID>
          <Email>string</Email>
          <MobileOrSMS>string</MobileOrSMS>
          <VoiceMessage>string</VoiceMessage>
        </NotificationPreferences>
        <Language1>int</Language1>
        <Language2>int</Language2>
        <Language3>int</Language3>
        <Language4>int</Language4>
        <EmployeeType>string</EmployeeType>
        <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
        <NPI>string</NPI>
        <InactiveReason>int</InactiveReason>
        <InactiveNote>string</InactiveNote>
        <SignedPayrollAgreementDate>dateTime</SignedPayrollAgreementDate>
      </CaregiverInfo>
    </CreateCaregiver>
  </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>
    <CreateCaregiverResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreateCaregiverResult>
        <CaregiverInfo>
          <CaregiverID>int</CaregiverID>
          <CaregiverCode>int</CaregiverCode>
        </CaregiverInfo>
      </CreateCaregiverResult>
    </CreateCaregiverResponse>
  </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>
    <CreateCaregiver xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverInfo>
        <OfficeID>int</OfficeID>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <Initials>string</Initials>
        <Gender>string</Gender>
        <Dependents>string</Dependents>
        <BirthDate>dateTime</BirthDate>
        <CaregiverCode>int</CaregiverCode>
        <AlternateCaregiverCode>string</AlternateCaregiverCode>
        <MobileID>int</MobileID>
        <MobileIDType>string</MobileIDType>
        <SSN>string</SSN>
        <EthnicityID>int</EthnicityID>
        <RehireDate>dateTime</RehireDate>
        <CountryOfBirth>string</CountryOfBirth>
        <MaritalStatus>string</MaritalStatus>
        <StatusID>int</StatusID>
        <EmploymentTypes>
          <Discipline>string</Discipline>
          <Discipline>string</Discipline>
        </EmploymentTypes>
        <EmployeeID>string</EmployeeID>
        <ApplicationDate>dateTime</ApplicationDate>
        <TeamID>int</TeamID>
        <BranchID>int</BranchID>
        <LocationID>int</LocationID>
        <HHAPCARegistryNumber>string</HHAPCARegistryNumber>
        <HHAPCARegistryCheckedDate>dateTime</HHAPCARegistryCheckedDate>
        <NYCRegistryCheckedDate>dateTime</NYCRegistryCheckedDate>
        <ReferralSourceID>int</ReferralSourceID>
        <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>
            <Name>string</Name>
            <RelationshipID>int</RelationshipID>
            <OtherRelationship>string</OtherRelationship>
            <Address>string</Address>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact>
          <EmergencyContact>
            <Name>string</Name>
            <RelationshipID>int</RelationshipID>
            <OtherRelationship>string</OtherRelationship>
            <Address>string</Address>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
          </EmergencyContact>
        </EmergencyContacts>
        <NotificationPreferences>
          <MethodID>int</MethodID>
          <Email>string</Email>
          <MobileOrSMS>string</MobileOrSMS>
          <VoiceMessage>string</VoiceMessage>
        </NotificationPreferences>
        <Language1>int</Language1>
        <Language2>int</Language2>
        <Language3>int</Language3>
        <Language4>int</Language4>
        <EmployeeType>string</EmployeeType>
        <ProfessionalLicensenumber>string</ProfessionalLicensenumber>
        <NPI>string</NPI>
        <InactiveReason>int</InactiveReason>
        <InactiveNote>string</InactiveNote>
        <SignedPayrollAgreementDate>dateTime</SignedPayrollAgreementDate>
      </CaregiverInfo>
    </CreateCaregiver>
  </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>
    <CreateCaregiverResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreateCaregiverResult>
        <CaregiverInfo>
          <CaregiverID>int</CaregiverID>
          <CaregiverCode>int</CaregiverCode>
        </CaregiverInfo>
      </CreateCaregiverResult>
    </CreateCaregiverResponse>
  </soap12:Body>
</soap12:Envelope>