ws


Click here for a complete list of operations.

GetCaregiverPreferences

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

<?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>
    <GetCaregiverPreferences xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverInfo>
        <ID>int</ID>
      </CaregiverInfo>
    </GetCaregiverPreferences>
  </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>
    <GetCaregiverPreferencesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverPreferencesResult>
        <CaregiverPreferencesInfo>
          <CaregiverID>int</CaregiverID>
          <LanguageID1>int</LanguageID1>
          <Language1>string</Language1>
          <LanguageID2>int</LanguageID2>
          <Language2>string</Language2>
          <LanguageID3>int</LanguageID3>
          <Language3>string</Language3>
          <LanguageID4>int</LanguageID4>
          <Language4>string</Language4>
          <Other>string</Other>
          <Preferences>
            <Preference xsi:nil="true" />
            <Preference xsi:nil="true" />
          </Preferences>
        </CaregiverPreferencesInfo>
      </GetCaregiverPreferencesResult>
    </GetCaregiverPreferencesResponse>
  </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>
    <GetCaregiverPreferences xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverInfo>
        <ID>int</ID>
      </CaregiverInfo>
    </GetCaregiverPreferences>
  </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>
    <GetCaregiverPreferencesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverPreferencesResult>
        <CaregiverPreferencesInfo>
          <CaregiverID>int</CaregiverID>
          <LanguageID1>int</LanguageID1>
          <Language1>string</Language1>
          <LanguageID2>int</LanguageID2>
          <Language2>string</Language2>
          <LanguageID3>int</LanguageID3>
          <Language3>string</Language3>
          <LanguageID4>int</LanguageID4>
          <Language4>string</Language4>
          <Other>string</Other>
          <Preferences>
            <Preference xsi:nil="true" />
            <Preference xsi:nil="true" />
          </Preferences>
        </CaregiverPreferencesInfo>
      </GetCaregiverPreferencesResult>
    </GetCaregiverPreferencesResponse>
  </soap12:Body>
</soap12:Envelope>