ws Web Service

Click here for a complete list of operations.

CreatePatientPOC

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

<?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>
    <CreatePatientPOC xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <PatientPOCInfo>
        <PatientID>int</PatientID>
        <StartDate>dateTime</StartDate>
        <StopDate>dateTime</StopDate>
        <Shift>int</Shift>
        <POCTasks>
          <POCTask>
            <POCTaskID>int</POCTaskID>
            <Minutes>int</Minutes>
            <AsRequested>boolean</AsRequested>
            <TimesPerWeekMin>int</TimesPerWeekMin>
            <TimesPerWeekMax>int</TimesPerWeekMax>
            <Instruction>string</Instruction>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
            <Mon>boolean</Mon>
            <Tue>boolean</Tue>
            <Wed>boolean</Wed>
            <Thu>boolean</Thu>
            <Fri>boolean</Fri>
          </POCTask>
          <POCTask>
            <POCTaskID>int</POCTaskID>
            <Minutes>int</Minutes>
            <AsRequested>boolean</AsRequested>
            <TimesPerWeekMin>int</TimesPerWeekMin>
            <TimesPerWeekMax>int</TimesPerWeekMax>
            <Instruction>string</Instruction>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
            <Mon>boolean</Mon>
            <Tue>boolean</Tue>
            <Wed>boolean</Wed>
            <Thu>boolean</Thu>
            <Fri>boolean</Fri>
          </POCTask>
        </POCTasks>
        <POCNote>string</POCNote>
      </PatientPOCInfo>
    </CreatePatientPOC>
  </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>
    <CreatePatientPOCResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreatePatientPOCResult>
        <CreatePatientPOC>
          <PatientID>int</PatientID>
          <POCHeaderID>int</POCHeaderID>
        </CreatePatientPOC>
      </CreatePatientPOCResult>
    </CreatePatientPOCResponse>
  </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>
    <CreatePatientPOC xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <PatientPOCInfo>
        <PatientID>int</PatientID>
        <StartDate>dateTime</StartDate>
        <StopDate>dateTime</StopDate>
        <Shift>int</Shift>
        <POCTasks>
          <POCTask>
            <POCTaskID>int</POCTaskID>
            <Minutes>int</Minutes>
            <AsRequested>boolean</AsRequested>
            <TimesPerWeekMin>int</TimesPerWeekMin>
            <TimesPerWeekMax>int</TimesPerWeekMax>
            <Instruction>string</Instruction>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
            <Mon>boolean</Mon>
            <Tue>boolean</Tue>
            <Wed>boolean</Wed>
            <Thu>boolean</Thu>
            <Fri>boolean</Fri>
          </POCTask>
          <POCTask>
            <POCTaskID>int</POCTaskID>
            <Minutes>int</Minutes>
            <AsRequested>boolean</AsRequested>
            <TimesPerWeekMin>int</TimesPerWeekMin>
            <TimesPerWeekMax>int</TimesPerWeekMax>
            <Instruction>string</Instruction>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
            <Mon>boolean</Mon>
            <Tue>boolean</Tue>
            <Wed>boolean</Wed>
            <Thu>boolean</Thu>
            <Fri>boolean</Fri>
          </POCTask>
        </POCTasks>
        <POCNote>string</POCNote>
      </PatientPOCInfo>
    </CreatePatientPOC>
  </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>
    <CreatePatientPOCResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreatePatientPOCResult>
        <CreatePatientPOC>
          <PatientID>int</PatientID>
          <POCHeaderID>int</POCHeaderID>
        </CreatePatientPOC>
      </CreatePatientPOCResult>
    </CreatePatientPOCResponse>
  </soap12:Body>
</soap12:Envelope>