ws


Click here for a complete list of operations.

AddCaregiverInService

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

<?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>
    <AddCaregiverInService xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverInServiceInfo>
        <CaregiverID>int</CaregiverID>
        <InServiceDate>dateTime</InServiceDate>
        <IsScheduled>string</IsScheduled>
        <FromTime>string</FromTime>
        <EndTime>string</EndTime>
        <NoShow>string</NoShow>
        <Reason>int</Reason>
        <Topics>
          <Topic>int</Topic>
          <Topic>int</Topic>
        </Topics>
        <InserviceCountCompliance>string</InserviceCountCompliance>
        <Location>string</Location>
        <Language>int</Language>
        <Instructor>int</Instructor>
        <Discipline>string</Discipline>
        <PayCode>int</PayCode>
        <Discipline2>string</Discipline2>
        <PayCode2>int</PayCode2>
        <Description>string</Description>
        <AllowForInServiceOverlap>string</AllowForInServiceOverlap>
      </CaregiverInServiceInfo>
    </AddCaregiverInService>
  </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>
    <AddCaregiverInServiceResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <AddCaregiverInServiceResult>
        <InServiceID>int</InServiceID>
        <CaregiverID>int</CaregiverID>
      </AddCaregiverInServiceResult>
    </AddCaregiverInServiceResponse>
  </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>
    <AddCaregiverInService xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverInServiceInfo>
        <CaregiverID>int</CaregiverID>
        <InServiceDate>dateTime</InServiceDate>
        <IsScheduled>string</IsScheduled>
        <FromTime>string</FromTime>
        <EndTime>string</EndTime>
        <NoShow>string</NoShow>
        <Reason>int</Reason>
        <Topics>
          <Topic>int</Topic>
          <Topic>int</Topic>
        </Topics>
        <InserviceCountCompliance>string</InserviceCountCompliance>
        <Location>string</Location>
        <Language>int</Language>
        <Instructor>int</Instructor>
        <Discipline>string</Discipline>
        <PayCode>int</PayCode>
        <Discipline2>string</Discipline2>
        <PayCode2>int</PayCode2>
        <Description>string</Description>
        <AllowForInServiceOverlap>string</AllowForInServiceOverlap>
      </CaregiverInServiceInfo>
    </AddCaregiverInService>
  </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>
    <AddCaregiverInServiceResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <AddCaregiverInServiceResult>
        <InServiceID>int</InServiceID>
        <CaregiverID>int</CaregiverID>
      </AddCaregiverInServiceResult>
    </AddCaregiverInServiceResponse>
  </soap12:Body>
</soap12:Envelope>