ws

Click here for a complete list of operations.

VisitCallInOut

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: app.hhaexchange.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.hhaexchange.com/apis/hhaws.integration/VisitCallInOut"

<?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>
    <VisitCallInOut xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitInfo>
        <CallUniqueID>int</CallUniqueID>
        <CaregiverFirstName>string</CaregiverFirstName>
        <CaregiverLastName>string</CaregiverLastName>
        <CaregiverDateOfBirth>dateTime</CaregiverDateOfBirth>
        <PatientFirstName>string</PatientFirstName>
        <PatientLastName>string</PatientLastName>
        <PatientDateOfBirth>dateTime</PatientDateOfBirth>
        <CallType>string</CallType>
        <CallTime>dateTime</CallTime>
        <Duties>
          <Duty>
            <DutyCode>int</DutyCode>
            <AdditionalData>decimal</AdditionalData>
            <Status>string</Status>
            <RefusedReasonCode>int</RefusedReasonCode>
          </Duty>
          <Duty>
            <DutyCode>int</DutyCode>
            <AdditionalData>decimal</AdditionalData>
            <Status>string</Status>
            <RefusedReasonCode>int</RefusedReasonCode>
          </Duty>
        </Duties>
      </VisitInfo>
    </VisitCallInOut>
  </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>
    <VisitCallInOutResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <VisitCallInOutResult>
        <CallUniqueID>int</CallUniqueID>
        <VisitID>long</VisitID>
        <Status>string</Status>
        <Comments>string</Comments>
      </VisitCallInOutResult>
    </VisitCallInOutResponse>
  </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: app.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>
    <VisitCallInOut xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitInfo>
        <CallUniqueID>int</CallUniqueID>
        <CaregiverFirstName>string</CaregiverFirstName>
        <CaregiverLastName>string</CaregiverLastName>
        <CaregiverDateOfBirth>dateTime</CaregiverDateOfBirth>
        <PatientFirstName>string</PatientFirstName>
        <PatientLastName>string</PatientLastName>
        <PatientDateOfBirth>dateTime</PatientDateOfBirth>
        <CallType>string</CallType>
        <CallTime>dateTime</CallTime>
        <Duties>
          <Duty>
            <DutyCode>int</DutyCode>
            <AdditionalData>decimal</AdditionalData>
            <Status>string</Status>
            <RefusedReasonCode>int</RefusedReasonCode>
          </Duty>
          <Duty>
            <DutyCode>int</DutyCode>
            <AdditionalData>decimal</AdditionalData>
            <Status>string</Status>
            <RefusedReasonCode>int</RefusedReasonCode>
          </Duty>
        </Duties>
      </VisitInfo>
    </VisitCallInOut>
  </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>
    <VisitCallInOutResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <VisitCallInOutResult>
        <CallUniqueID>int</CallUniqueID>
        <VisitID>long</VisitID>
        <Status>string</Status>
        <Comments>string</Comments>
      </VisitCallInOutResult>
    </VisitCallInOutResponse>
  </soap12:Body>
</soap12:Envelope>