ws

Click here for a complete list of operations.

GetCaregiverNotes

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

<?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>
    <GetCaregiverNotes xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverID>int</CaregiverID>
      <ModifiedAfter>dateTime</ModifiedAfter>
      <LastCaregiverNoteID>long</LastCaregiverNoteID>
    </GetCaregiverNotes>
  </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>
    <GetCaregiverNotesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverNotesResult>
        <CaregiverNotes>
          <CaregiverNoteInfo>
            <CaregiverNoteID>long</CaregiverNoteID>
            <CaregiverID>int</CaregiverID>
            <NoteDate>string</NoteDate>
            <Note>string</Note>
            <Patient xsi:nil="true" />
            <Subject xsi:nil="true" />
            <CaregiverNotified>string</CaregiverNotified>
          </CaregiverNoteInfo>
          <CaregiverNoteInfo>
            <CaregiverNoteID>long</CaregiverNoteID>
            <CaregiverID>int</CaregiverID>
            <NoteDate>string</NoteDate>
            <Note>string</Note>
            <Patient xsi:nil="true" />
            <Subject xsi:nil="true" />
            <CaregiverNotified>string</CaregiverNotified>
          </CaregiverNoteInfo>
        </CaregiverNotes>
      </GetCaregiverNotesResult>
    </GetCaregiverNotesResponse>
  </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>
    <GetCaregiverNotes xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverID>int</CaregiverID>
      <ModifiedAfter>dateTime</ModifiedAfter>
      <LastCaregiverNoteID>long</LastCaregiverNoteID>
    </GetCaregiverNotes>
  </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>
    <GetCaregiverNotesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetCaregiverNotesResult>
        <CaregiverNotes>
          <CaregiverNoteInfo>
            <CaregiverNoteID>long</CaregiverNoteID>
            <CaregiverID>int</CaregiverID>
            <NoteDate>string</NoteDate>
            <Note>string</Note>
            <Patient xsi:nil="true" />
            <Subject xsi:nil="true" />
            <CaregiverNotified>string</CaregiverNotified>
          </CaregiverNoteInfo>
          <CaregiverNoteInfo>
            <CaregiverNoteID>long</CaregiverNoteID>
            <CaregiverID>int</CaregiverID>
            <NoteDate>string</NoteDate>
            <Note>string</Note>
            <Patient xsi:nil="true" />
            <Subject xsi:nil="true" />
            <CaregiverNotified>string</CaregiverNotified>
          </CaregiverNoteInfo>
        </CaregiverNotes>
      </GetCaregiverNotesResult>
    </GetCaregiverNotesResponse>
  </soap12:Body>
</soap12:Envelope>