ws Web Service

Click here for a complete list of operations.

GetCaregiverSpecialAvailability

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

<?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>
    <GetCaregiverSpecialAvailability xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverID>int</CaregiverID>
    </GetCaregiverSpecialAvailability>
  </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>
    <GetCaregiverSpecialAvailabilityResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverSpecialAvailabilityResult>
        <SpecialAvailability>
          <SpecialAvailabilityInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <SpecialAvailabilityID>int</SpecialAvailabilityID>
            <CaregiverID>int</CaregiverID>
            <FromDate>string</FromDate>
            <ToDate>string</ToDate>
            <SaturdayAvailabilityType>string</SaturdayAvailabilityType>
            <SaturdayLiveIn>string</SaturdayLiveIn>
            <SaturdayFrom>string</SaturdayFrom>
            <SaturdayTo>string</SaturdayTo>
            <SundayAvailabilityType>string</SundayAvailabilityType>
            <SundayLiveIn>string</SundayLiveIn>
            <SundayFrom>string</SundayFrom>
            <SundayTo>string</SundayTo>
            <MondayAvailabilityType>string</MondayAvailabilityType>
            <MondayLiveIn>string</MondayLiveIn>
            <MondayFrom>string</MondayFrom>
            <MondayTo>string</MondayTo>
            <TuesdayAvailabilityType>string</TuesdayAvailabilityType>
            <TuesdayLiveIn>string</TuesdayLiveIn>
            <TuesdayFrom>string</TuesdayFrom>
            <TuesdayTo>string</TuesdayTo>
            <WednesdayAvailabilityType>string</WednesdayAvailabilityType>
            <WednesdayLiveIn>string</WednesdayLiveIn>
            <WednesdayFrom>string</WednesdayFrom>
            <WednesdayTo>string</WednesdayTo>
            <ThursdayAvailabilityType>string</ThursdayAvailabilityType>
            <ThursdayLiveIn>string</ThursdayLiveIn>
            <ThursdayFrom>string</ThursdayFrom>
            <ThursdayTo>string</ThursdayTo>
            <FridayAvailabilityType>string</FridayAvailabilityType>
            <FridayLiveIn>string</FridayLiveIn>
            <FridayFrom>string</FridayFrom>
            <FridayTo>string</FridayTo>
          </SpecialAvailabilityInfo>
          <SpecialAvailabilityInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <SpecialAvailabilityID>int</SpecialAvailabilityID>
            <CaregiverID>int</CaregiverID>
            <FromDate>string</FromDate>
            <ToDate>string</ToDate>
            <SaturdayAvailabilityType>string</SaturdayAvailabilityType>
            <SaturdayLiveIn>string</SaturdayLiveIn>
            <SaturdayFrom>string</SaturdayFrom>
            <SaturdayTo>string</SaturdayTo>
            <SundayAvailabilityType>string</SundayAvailabilityType>
            <SundayLiveIn>string</SundayLiveIn>
            <SundayFrom>string</SundayFrom>
            <SundayTo>string</SundayTo>
            <MondayAvailabilityType>string</MondayAvailabilityType>
            <MondayLiveIn>string</MondayLiveIn>
            <MondayFrom>string</MondayFrom>
            <MondayTo>string</MondayTo>
            <TuesdayAvailabilityType>string</TuesdayAvailabilityType>
            <TuesdayLiveIn>string</TuesdayLiveIn>
            <TuesdayFrom>string</TuesdayFrom>
            <TuesdayTo>string</TuesdayTo>
            <WednesdayAvailabilityType>string</WednesdayAvailabilityType>
            <WednesdayLiveIn>string</WednesdayLiveIn>
            <WednesdayFrom>string</WednesdayFrom>
            <WednesdayTo>string</WednesdayTo>
            <ThursdayAvailabilityType>string</ThursdayAvailabilityType>
            <ThursdayLiveIn>string</ThursdayLiveIn>
            <ThursdayFrom>string</ThursdayFrom>
            <ThursdayTo>string</ThursdayTo>
            <FridayAvailabilityType>string</FridayAvailabilityType>
            <FridayLiveIn>string</FridayLiveIn>
            <FridayFrom>string</FridayFrom>
            <FridayTo>string</FridayTo>
          </SpecialAvailabilityInfo>
        </SpecialAvailability>
      </GetCaregiverSpecialAvailabilityResult>
    </GetCaregiverSpecialAvailabilityResponse>
  </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>
    <GetCaregiverSpecialAvailability xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverID>int</CaregiverID>
    </GetCaregiverSpecialAvailability>
  </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>
    <GetCaregiverSpecialAvailabilityResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverSpecialAvailabilityResult>
        <SpecialAvailability>
          <SpecialAvailabilityInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <SpecialAvailabilityID>int</SpecialAvailabilityID>
            <CaregiverID>int</CaregiverID>
            <FromDate>string</FromDate>
            <ToDate>string</ToDate>
            <SaturdayAvailabilityType>string</SaturdayAvailabilityType>
            <SaturdayLiveIn>string</SaturdayLiveIn>
            <SaturdayFrom>string</SaturdayFrom>
            <SaturdayTo>string</SaturdayTo>
            <SundayAvailabilityType>string</SundayAvailabilityType>
            <SundayLiveIn>string</SundayLiveIn>
            <SundayFrom>string</SundayFrom>
            <SundayTo>string</SundayTo>
            <MondayAvailabilityType>string</MondayAvailabilityType>
            <MondayLiveIn>string</MondayLiveIn>
            <MondayFrom>string</MondayFrom>
            <MondayTo>string</MondayTo>
            <TuesdayAvailabilityType>string</TuesdayAvailabilityType>
            <TuesdayLiveIn>string</TuesdayLiveIn>
            <TuesdayFrom>string</TuesdayFrom>
            <TuesdayTo>string</TuesdayTo>
            <WednesdayAvailabilityType>string</WednesdayAvailabilityType>
            <WednesdayLiveIn>string</WednesdayLiveIn>
            <WednesdayFrom>string</WednesdayFrom>
            <WednesdayTo>string</WednesdayTo>
            <ThursdayAvailabilityType>string</ThursdayAvailabilityType>
            <ThursdayLiveIn>string</ThursdayLiveIn>
            <ThursdayFrom>string</ThursdayFrom>
            <ThursdayTo>string</ThursdayTo>
            <FridayAvailabilityType>string</FridayAvailabilityType>
            <FridayLiveIn>string</FridayLiveIn>
            <FridayFrom>string</FridayFrom>
            <FridayTo>string</FridayTo>
          </SpecialAvailabilityInfo>
          <SpecialAvailabilityInfo>
            <AgencyID>int</AgencyID>
            <OfficeID>int</OfficeID>
            <SpecialAvailabilityID>int</SpecialAvailabilityID>
            <CaregiverID>int</CaregiverID>
            <FromDate>string</FromDate>
            <ToDate>string</ToDate>
            <SaturdayAvailabilityType>string</SaturdayAvailabilityType>
            <SaturdayLiveIn>string</SaturdayLiveIn>
            <SaturdayFrom>string</SaturdayFrom>
            <SaturdayTo>string</SaturdayTo>
            <SundayAvailabilityType>string</SundayAvailabilityType>
            <SundayLiveIn>string</SundayLiveIn>
            <SundayFrom>string</SundayFrom>
            <SundayTo>string</SundayTo>
            <MondayAvailabilityType>string</MondayAvailabilityType>
            <MondayLiveIn>string</MondayLiveIn>
            <MondayFrom>string</MondayFrom>
            <MondayTo>string</MondayTo>
            <TuesdayAvailabilityType>string</TuesdayAvailabilityType>
            <TuesdayLiveIn>string</TuesdayLiveIn>
            <TuesdayFrom>string</TuesdayFrom>
            <TuesdayTo>string</TuesdayTo>
            <WednesdayAvailabilityType>string</WednesdayAvailabilityType>
            <WednesdayLiveIn>string</WednesdayLiveIn>
            <WednesdayFrom>string</WednesdayFrom>
            <WednesdayTo>string</WednesdayTo>
            <ThursdayAvailabilityType>string</ThursdayAvailabilityType>
            <ThursdayLiveIn>string</ThursdayLiveIn>
            <ThursdayFrom>string</ThursdayFrom>
            <ThursdayTo>string</ThursdayTo>
            <FridayAvailabilityType>string</FridayAvailabilityType>
            <FridayLiveIn>string</FridayLiveIn>
            <FridayFrom>string</FridayFrom>
            <FridayTo>string</FridayTo>
          </SpecialAvailabilityInfo>
        </SpecialAvailability>
      </GetCaregiverSpecialAvailabilityResult>
    </GetCaregiverSpecialAvailabilityResponse>
  </soap12:Body>
</soap12:Envelope>