ws Web Service

Click here for a complete list of operations.

UpdateSchedule

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

<?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>
    <UpdateSchedule xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <ScheduleInfo>
        <VisitID>int</VisitID>
        <VisitType>string</VisitType>
        <ScheduleDurationHours>int</ScheduleDurationHours>
        <ScheduleDurationMinutes>int</ScheduleDurationMinutes>
        <ScheduleStartTime>string</ScheduleStartTime>
        <ScheduleEndTime>string</ScheduleEndTime>
        <IsScheduleTemporary>string</IsScheduleTemporary>
        <CaregiverID>int</CaregiverID>
        <CaregiverCode>string</CaregiverCode>
        <CaregiverFirstName>string</CaregiverFirstName>
        <CaregiverLastName>string</CaregiverLastName>
        <CaregiverDateOfBirth>dateTime</CaregiverDateOfBirth>
        <PayCodeID>int</PayCodeID>
        <PayCodeName>string</PayCodeName>
        <IsCaregiverTemporary>string</IsCaregiverTemporary>
        <PrimaryBillTo>
          <ContractID>int</ContractID>
          <ContractName>string</ContractName>
          <ServiceCodeID>int</ServiceCodeID>
          <ServiceCodeName>string</ServiceCodeName>
          <Hours>int</Hours>
          <Minutes>int</Minutes>
          <BudgetNumber>int</BudgetNumber>
        </PrimaryBillTo>
        <SecondaryBillTo>
          <ContractID>int</ContractID>
          <ContractName>string</ContractName>
          <ServiceCodeID>int</ServiceCodeID>
          <ServiceCodeName>string</ServiceCodeName>
          <Hours>int</Hours>
          <Minutes>int</Minutes>
        </SecondaryBillTo>
        <ScheduleBillInfoEditReasonsID>int</ScheduleBillInfoEditReasonsID>
        <Note>string</Note>
        <IsUpdateOnlyBilledAmount>string</IsUpdateOnlyBilledAmount>
        <BilledAmount>decimal</BilledAmount>
        <SuggestedStartTime>string</SuggestedStartTime>
        <SuggestedEndTime>string</SuggestedEndTime>
      </ScheduleInfo>
    </UpdateSchedule>
  </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>
    <UpdateScheduleResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <UpdateScheduleResult>
        <PatientID>int</PatientID>
        <VisitID>int</VisitID>
      </UpdateScheduleResult>
    </UpdateScheduleResponse>
  </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>
    <UpdateSchedule xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <ScheduleInfo>
        <VisitID>int</VisitID>
        <VisitType>string</VisitType>
        <ScheduleDurationHours>int</ScheduleDurationHours>
        <ScheduleDurationMinutes>int</ScheduleDurationMinutes>
        <ScheduleStartTime>string</ScheduleStartTime>
        <ScheduleEndTime>string</ScheduleEndTime>
        <IsScheduleTemporary>string</IsScheduleTemporary>
        <CaregiverID>int</CaregiverID>
        <CaregiverCode>string</CaregiverCode>
        <CaregiverFirstName>string</CaregiverFirstName>
        <CaregiverLastName>string</CaregiverLastName>
        <CaregiverDateOfBirth>dateTime</CaregiverDateOfBirth>
        <PayCodeID>int</PayCodeID>
        <PayCodeName>string</PayCodeName>
        <IsCaregiverTemporary>string</IsCaregiverTemporary>
        <PrimaryBillTo>
          <ContractID>int</ContractID>
          <ContractName>string</ContractName>
          <ServiceCodeID>int</ServiceCodeID>
          <ServiceCodeName>string</ServiceCodeName>
          <Hours>int</Hours>
          <Minutes>int</Minutes>
          <BudgetNumber>int</BudgetNumber>
        </PrimaryBillTo>
        <SecondaryBillTo>
          <ContractID>int</ContractID>
          <ContractName>string</ContractName>
          <ServiceCodeID>int</ServiceCodeID>
          <ServiceCodeName>string</ServiceCodeName>
          <Hours>int</Hours>
          <Minutes>int</Minutes>
        </SecondaryBillTo>
        <ScheduleBillInfoEditReasonsID>int</ScheduleBillInfoEditReasonsID>
        <Note>string</Note>
        <IsUpdateOnlyBilledAmount>string</IsUpdateOnlyBilledAmount>
        <BilledAmount>decimal</BilledAmount>
        <SuggestedStartTime>string</SuggestedStartTime>
        <SuggestedEndTime>string</SuggestedEndTime>
      </ScheduleInfo>
    </UpdateSchedule>
  </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>
    <UpdateScheduleResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <UpdateScheduleResult>
        <PatientID>int</PatientID>
        <VisitID>int</VisitID>
      </UpdateScheduleResult>
    </UpdateScheduleResponse>
  </soap12:Body>
</soap12:Envelope>