ResidentNotificationService


Click here for a complete list of operations.

GetPendingResidentNotifications

Get pending resident notification messages for a specified Account and Vendor Interface.

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 /SigmaCareWebServices/ResidentNotificationService.asmx HTTP/1.1
Host: interfaces.sigmacare.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://interfaces.sigmacare.com/Resident/ResidentNotificationService/GetPendingResidentNotifications"

<?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>
    <GetPendingResidentNotifications xmlns="http://interfaces.sigmacare.com/Resident/ResidentNotificationService">
      <accountID>long</accountID>
      <vendorInterfaceID>guid</vendorInterfaceID>
    </GetPendingResidentNotifications>
  </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>
    <GetPendingResidentNotificationsResponse xmlns="http://interfaces.sigmacare.com/Resident/ResidentNotificationService">
      <GetPendingResidentNotificationsResult>
        <ResidentNotification AccountID="long" PartnerID="long" MessageID="string" InterfaceEventID="string" VendorInterfaceID="string">
          <Message xmlns="http://EHS.Integration.ResidentMgmt.Data.ResidentNotification">string</Message>
        </ResidentNotification>
        <ResidentNotification AccountID="long" PartnerID="long" MessageID="string" InterfaceEventID="string" VendorInterfaceID="string">
          <Message xmlns="http://EHS.Integration.ResidentMgmt.Data.ResidentNotification">string</Message>
        </ResidentNotification>
      </GetPendingResidentNotificationsResult>
    </GetPendingResidentNotificationsResponse>
  </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 /SigmaCareWebServices/ResidentNotificationService.asmx HTTP/1.1
Host: interfaces.sigmacare.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>
    <GetPendingResidentNotifications xmlns="http://interfaces.sigmacare.com/Resident/ResidentNotificationService">
      <accountID>long</accountID>
      <vendorInterfaceID>guid</vendorInterfaceID>
    </GetPendingResidentNotifications>
  </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>
    <GetPendingResidentNotificationsResponse xmlns="http://interfaces.sigmacare.com/Resident/ResidentNotificationService">
      <GetPendingResidentNotificationsResult>
        <ResidentNotification AccountID="long" PartnerID="long" MessageID="string" InterfaceEventID="string" VendorInterfaceID="string">
          <Message xmlns="http://EHS.Integration.ResidentMgmt.Data.ResidentNotification">string</Message>
        </ResidentNotification>
        <ResidentNotification AccountID="long" PartnerID="long" MessageID="string" InterfaceEventID="string" VendorInterfaceID="string">
          <Message xmlns="http://EHS.Integration.ResidentMgmt.Data.ResidentNotification">string</Message>
        </ResidentNotification>
      </GetPendingResidentNotificationsResult>
    </GetPendingResidentNotificationsResponse>
  </soap12:Body>
</soap12:Envelope>