ws

Click here for a complete list of operations.

SearchCaregiverDocument

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

<?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>
    <SearchCaregiverDocument xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <SearchFilters>
        <CaregiverID>int</CaregiverID>
        <CaregiverDocumentTypeID>int</CaregiverDocumentTypeID>
        <CaregiverDocumentID>int</CaregiverDocumentID>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
      </SearchFilters>
    </SearchCaregiverDocument>
  </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>
    <SearchCaregiverDocumentResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <SearchCaregiverDocumentResult>
        <CaregiverDocuments>
          <CaregiverDocument>
            <CaregiverDocID>int</CaregiverDocID>
            <CaregiverID>int</CaregiverID>
            <CaregiverDocumentTypeID>int</CaregiverDocumentTypeID>
            <CaregiverDocumentType>string</CaregiverDocumentType>
            <Description>string</Description>
            <FileName>string</FileName>
            <CreatedBy>string</CreatedBy>
            <CreatedOn>dateTime</CreatedOn>
            <FileSize>string</FileSize>
          </CaregiverDocument>
          <CaregiverDocument>
            <CaregiverDocID>int</CaregiverDocID>
            <CaregiverID>int</CaregiverID>
            <CaregiverDocumentTypeID>int</CaregiverDocumentTypeID>
            <CaregiverDocumentType>string</CaregiverDocumentType>
            <Description>string</Description>
            <FileName>string</FileName>
            <CreatedBy>string</CreatedBy>
            <CreatedOn>dateTime</CreatedOn>
            <FileSize>string</FileSize>
          </CaregiverDocument>
        </CaregiverDocuments>
      </SearchCaregiverDocumentResult>
    </SearchCaregiverDocumentResponse>
  </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>
    <SearchCaregiverDocument xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <SearchFilters>
        <CaregiverID>int</CaregiverID>
        <CaregiverDocumentTypeID>int</CaregiverDocumentTypeID>
        <CaregiverDocumentID>int</CaregiverDocumentID>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
      </SearchFilters>
    </SearchCaregiverDocument>
  </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>
    <SearchCaregiverDocumentResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <SearchCaregiverDocumentResult>
        <CaregiverDocuments>
          <CaregiverDocument>
            <CaregiverDocID>int</CaregiverDocID>
            <CaregiverID>int</CaregiverID>
            <CaregiverDocumentTypeID>int</CaregiverDocumentTypeID>
            <CaregiverDocumentType>string</CaregiverDocumentType>
            <Description>string</Description>
            <FileName>string</FileName>
            <CreatedBy>string</CreatedBy>
            <CreatedOn>dateTime</CreatedOn>
            <FileSize>string</FileSize>
          </CaregiverDocument>
          <CaregiverDocument>
            <CaregiverDocID>int</CaregiverDocID>
            <CaregiverID>int</CaregiverID>
            <CaregiverDocumentTypeID>int</CaregiverDocumentTypeID>
            <CaregiverDocumentType>string</CaregiverDocumentType>
            <Description>string</Description>
            <FileName>string</FileName>
            <CreatedBy>string</CreatedBy>
            <CreatedOn>dateTime</CreatedOn>
            <FileSize>string</FileSize>
          </CaregiverDocument>
        </CaregiverDocuments>
      </SearchCaregiverDocumentResult>
    </SearchCaregiverDocumentResponse>
  </soap12:Body>
</soap12:Envelope>