ws

Click here for a complete list of operations.

GetCaregiverMedicalDetails

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

<?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>
    <GetCaregiverMedicalDetails xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <SearchFilter>
        <CaregiverID>string</CaregiverID>
        <CaregiverComplianceExpItemID>string</CaregiverComplianceExpItemID>
        <ComplianceStatus>string</ComplianceStatus>
      </SearchFilter>
    </GetCaregiverMedicalDetails>
  </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>
    <GetCaregiverMedicalDetailsResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverMedicalDetailsResult>
        <CaregiverMedicalDetails>
          <OfficeID>int</OfficeID>
          <CaregiverID>int</CaregiverID>
          <CaregiverMedicalID>int</CaregiverMedicalID>
          <MedicalID>int</MedicalID>
          <MedicalName>string</MedicalName>
          <Required>string</Required>
          <Status>string</Status>
          <Result>string</Result>
          <Notes>string</Notes>
          <DocumentName>string</DocumentName>
          <DueDate>string</DueDate>
          <DatePerformed>string</DatePerformed>
          <ModifiedDate>string</ModifiedDate>
        </CaregiverMedicalDetails>
        <CaregiverMedicalDetails>
          <OfficeID>int</OfficeID>
          <CaregiverID>int</CaregiverID>
          <CaregiverMedicalID>int</CaregiverMedicalID>
          <MedicalID>int</MedicalID>
          <MedicalName>string</MedicalName>
          <Required>string</Required>
          <Status>string</Status>
          <Result>string</Result>
          <Notes>string</Notes>
          <DocumentName>string</DocumentName>
          <DueDate>string</DueDate>
          <DatePerformed>string</DatePerformed>
          <ModifiedDate>string</ModifiedDate>
        </CaregiverMedicalDetails>
      </GetCaregiverMedicalDetailsResult>
    </GetCaregiverMedicalDetailsResponse>
  </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>
    <GetCaregiverMedicalDetails xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <SearchFilter>
        <CaregiverID>string</CaregiverID>
        <CaregiverComplianceExpItemID>string</CaregiverComplianceExpItemID>
        <ComplianceStatus>string</ComplianceStatus>
      </SearchFilter>
    </GetCaregiverMedicalDetails>
  </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>
    <GetCaregiverMedicalDetailsResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverMedicalDetailsResult>
        <CaregiverMedicalDetails>
          <OfficeID>int</OfficeID>
          <CaregiverID>int</CaregiverID>
          <CaregiverMedicalID>int</CaregiverMedicalID>
          <MedicalID>int</MedicalID>
          <MedicalName>string</MedicalName>
          <Required>string</Required>
          <Status>string</Status>
          <Result>string</Result>
          <Notes>string</Notes>
          <DocumentName>string</DocumentName>
          <DueDate>string</DueDate>
          <DatePerformed>string</DatePerformed>
          <ModifiedDate>string</ModifiedDate>
        </CaregiverMedicalDetails>
        <CaregiverMedicalDetails>
          <OfficeID>int</OfficeID>
          <CaregiverID>int</CaregiverID>
          <CaregiverMedicalID>int</CaregiverMedicalID>
          <MedicalID>int</MedicalID>
          <MedicalName>string</MedicalName>
          <Required>string</Required>
          <Status>string</Status>
          <Result>string</Result>
          <Notes>string</Notes>
          <DocumentName>string</DocumentName>
          <DueDate>string</DueDate>
          <DatePerformed>string</DatePerformed>
          <ModifiedDate>string</ModifiedDate>
        </CaregiverMedicalDetails>
      </GetCaregiverMedicalDetailsResult>
    </GetCaregiverMedicalDetailsResponse>
  </soap12:Body>
</soap12:Envelope>