ws Web Service

Click here for a complete list of operations.

SearchPhoneNumber

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

<?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>
    <SearchPhoneNumber xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <SearchFilters>
        <OfficeID>int</OfficeID>
        <PhoneNumber>long</PhoneNumber>
        <SearchPatients>string</SearchPatients>
        <SearchCaregivers>string</SearchCaregivers>
      </SearchFilters>
    </SearchPhoneNumber>
  </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>
    <SearchPhoneNumberResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <SearchPhoneNumberResult>
        <Patients>
          <Patient>
            <PatientID>int</PatientID>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <AdmissionID>string</AdmissionID>
            <Coordinators xsi:nil="true" />
            <AcceptedServices xsi:nil="true" />
            <PrimaryContract xsi:nil="true" />
            <Team xsi:nil="true" />
            <Location xsi:nil="true" />
            <Branch xsi:nil="true" />
            <PrimaryLanguage xsi:nil="true" />
            <City>string</City>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <State>string</State>
            <Nurse xsi:nil="true" />
          </Patient>
          <Patient>
            <PatientID>int</PatientID>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <AdmissionID>string</AdmissionID>
            <Coordinators xsi:nil="true" />
            <AcceptedServices xsi:nil="true" />
            <PrimaryContract xsi:nil="true" />
            <Team xsi:nil="true" />
            <Location xsi:nil="true" />
            <Branch xsi:nil="true" />
            <PrimaryLanguage xsi:nil="true" />
            <City>string</City>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <State>string</State>
            <Nurse xsi:nil="true" />
          </Patient>
        </Patients>
        <Caregivers>
          <Caregiver>
            <CaregiverID>int</CaregiverID>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <CaregiverCode>string</CaregiverCode>
            <EmploymentTypes xsi:nil="true" />
            <Team xsi:nil="true" />
            <Location xsi:nil="true" />
            <Branch xsi:nil="true" />
            <PrimaryLanguage xsi:nil="true" />
            <City>string</City>
            <State>string</State>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
          </Caregiver>
          <Caregiver>
            <CaregiverID>int</CaregiverID>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <CaregiverCode>string</CaregiverCode>
            <EmploymentTypes xsi:nil="true" />
            <Team xsi:nil="true" />
            <Location xsi:nil="true" />
            <Branch xsi:nil="true" />
            <PrimaryLanguage xsi:nil="true" />
            <City>string</City>
            <State>string</State>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
          </Caregiver>
        </Caregivers>
      </SearchPhoneNumberResult>
    </SearchPhoneNumberResponse>
  </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>
    <SearchPhoneNumber xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <SearchFilters>
        <OfficeID>int</OfficeID>
        <PhoneNumber>long</PhoneNumber>
        <SearchPatients>string</SearchPatients>
        <SearchCaregivers>string</SearchCaregivers>
      </SearchFilters>
    </SearchPhoneNumber>
  </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>
    <SearchPhoneNumberResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <SearchPhoneNumberResult>
        <Patients>
          <Patient>
            <PatientID>int</PatientID>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <AdmissionID>string</AdmissionID>
            <Coordinators xsi:nil="true" />
            <AcceptedServices xsi:nil="true" />
            <PrimaryContract xsi:nil="true" />
            <Team xsi:nil="true" />
            <Location xsi:nil="true" />
            <Branch xsi:nil="true" />
            <PrimaryLanguage xsi:nil="true" />
            <City>string</City>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <State>string</State>
            <Nurse xsi:nil="true" />
          </Patient>
          <Patient>
            <PatientID>int</PatientID>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <AdmissionID>string</AdmissionID>
            <Coordinators xsi:nil="true" />
            <AcceptedServices xsi:nil="true" />
            <PrimaryContract xsi:nil="true" />
            <Team xsi:nil="true" />
            <Location xsi:nil="true" />
            <Branch xsi:nil="true" />
            <PrimaryLanguage xsi:nil="true" />
            <City>string</City>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <State>string</State>
            <Nurse xsi:nil="true" />
          </Patient>
        </Patients>
        <Caregivers>
          <Caregiver>
            <CaregiverID>int</CaregiverID>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <CaregiverCode>string</CaregiverCode>
            <EmploymentTypes xsi:nil="true" />
            <Team xsi:nil="true" />
            <Location xsi:nil="true" />
            <Branch xsi:nil="true" />
            <PrimaryLanguage xsi:nil="true" />
            <City>string</City>
            <State>string</State>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
          </Caregiver>
          <Caregiver>
            <CaregiverID>int</CaregiverID>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <CaregiverCode>string</CaregiverCode>
            <EmploymentTypes xsi:nil="true" />
            <Team xsi:nil="true" />
            <Location xsi:nil="true" />
            <Branch xsi:nil="true" />
            <PrimaryLanguage xsi:nil="true" />
            <City>string</City>
            <State>string</State>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
          </Caregiver>
        </Caregivers>
      </SearchPhoneNumberResult>
    </SearchPhoneNumberResponse>
  </soap12:Body>
</soap12:Envelope>