ws Web Service

Click here for a complete list of operations.

GetCaregiverInServices

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

<?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>
    <GetCaregiverInServices xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverID>int</CaregiverID>
    </GetCaregiverInServices>
  </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>
    <GetCaregiverInServicesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverInServicesResult>
        <CaregiverInServices>
          <CaregiverInServicesInfo>
            <InServiceID>int</InServiceID>
            <CaregiverID>int</CaregiverID>
            <InserviceDate>string</InserviceDate>
            <FromTime>int</FromTime>
            <EndTime>int</EndTime>
            <NoShow>string</NoShow>
            <NoShowReason xsi:nil="true" />
            <Topics xsi:nil="true" />
            <Location>string</Location>
            <Instructor xsi:nil="true" />
            <Language xsi:nil="true" />
            <Discipline1 xsi:nil="true" />
            <PayRate1 xsi:nil="true" />
            <Discipline2 xsi:nil="true" />
            <PayRate2 xsi:nil="true" />
            <Description>string</Description>
            <InserviceCountCompliance>string</InserviceCountCompliance>
            <AllowForInServiceOverlap>string</AllowForInServiceOverlap>
          </CaregiverInServicesInfo>
          <CaregiverInServicesInfo>
            <InServiceID>int</InServiceID>
            <CaregiverID>int</CaregiverID>
            <InserviceDate>string</InserviceDate>
            <FromTime>int</FromTime>
            <EndTime>int</EndTime>
            <NoShow>string</NoShow>
            <NoShowReason xsi:nil="true" />
            <Topics xsi:nil="true" />
            <Location>string</Location>
            <Instructor xsi:nil="true" />
            <Language xsi:nil="true" />
            <Discipline1 xsi:nil="true" />
            <PayRate1 xsi:nil="true" />
            <Discipline2 xsi:nil="true" />
            <PayRate2 xsi:nil="true" />
            <Description>string</Description>
            <InserviceCountCompliance>string</InserviceCountCompliance>
            <AllowForInServiceOverlap>string</AllowForInServiceOverlap>
          </CaregiverInServicesInfo>
        </CaregiverInServices>
      </GetCaregiverInServicesResult>
    </GetCaregiverInServicesResponse>
  </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>
    <GetCaregiverInServices xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverID>int</CaregiverID>
    </GetCaregiverInServices>
  </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>
    <GetCaregiverInServicesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverInServicesResult>
        <CaregiverInServices>
          <CaregiverInServicesInfo>
            <InServiceID>int</InServiceID>
            <CaregiverID>int</CaregiverID>
            <InserviceDate>string</InserviceDate>
            <FromTime>int</FromTime>
            <EndTime>int</EndTime>
            <NoShow>string</NoShow>
            <NoShowReason xsi:nil="true" />
            <Topics xsi:nil="true" />
            <Location>string</Location>
            <Instructor xsi:nil="true" />
            <Language xsi:nil="true" />
            <Discipline1 xsi:nil="true" />
            <PayRate1 xsi:nil="true" />
            <Discipline2 xsi:nil="true" />
            <PayRate2 xsi:nil="true" />
            <Description>string</Description>
            <InserviceCountCompliance>string</InserviceCountCompliance>
            <AllowForInServiceOverlap>string</AllowForInServiceOverlap>
          </CaregiverInServicesInfo>
          <CaregiverInServicesInfo>
            <InServiceID>int</InServiceID>
            <CaregiverID>int</CaregiverID>
            <InserviceDate>string</InserviceDate>
            <FromTime>int</FromTime>
            <EndTime>int</EndTime>
            <NoShow>string</NoShow>
            <NoShowReason xsi:nil="true" />
            <Topics xsi:nil="true" />
            <Location>string</Location>
            <Instructor xsi:nil="true" />
            <Language xsi:nil="true" />
            <Discipline1 xsi:nil="true" />
            <PayRate1 xsi:nil="true" />
            <Discipline2 xsi:nil="true" />
            <PayRate2 xsi:nil="true" />
            <Description>string</Description>
            <InserviceCountCompliance>string</InserviceCountCompliance>
            <AllowForInServiceOverlap>string</AllowForInServiceOverlap>
          </CaregiverInServicesInfo>
        </CaregiverInServices>
      </GetCaregiverInServicesResult>
    </GetCaregiverInServicesResponse>
  </soap12:Body>
</soap12:Envelope>