OMS_IVR Web Service

OMS_IVR

Click here for a complete list of operations.

ODEventNotification

Publisher notifies subscriber of non-outage events by sending the a customerCall object. (Optional)

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 /OMS_IVR_Webservice/OMS_IVR.asmx HTTP/1.1
Host: outagemap.adamselectric.coop
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.multispeak.org/Version_3.0/ODEventNotification"

<?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:Header>
    <MultiSpeakMsgHeader Version="string" UserID="string" Pwd="string" AppName="string" AppVersion="string" Company="string" CSUnits="feet or meters or USSurveyFeet or other" CoordinateSystem="string" Datum="string" SessionID="string" PreviousSessionID="string" ObjectsRemaining="integer" LastSent="string" xmlns="http://www.multispeak.org/Version_3.0" />
  </soap:Header>
  <soap:Body>
    <ODEventNotification xmlns="http://www.multispeak.org/Version_3.0">
      <ODEvents>
        <outageDetectionEvent>
          <phaseCd>A or B or C or AB or AC or BC or ABC or Unknown</phaseCd>
          <eventTime>dateTime</eventTime>
          <outageEventType>Instantaneous or Outage or Restoration or NoResponse or Inferred or PowerOn or PowerOff</outageEventType>
          <outageDetectDeviceID>string</outageDetectDeviceID>
          <outageDetectDeviceType>Call or CustomerServiceRep or InboundTelephoneDevice or Meter or Other</outageDetectDeviceType>
          <outageLocation>
            <servLoc>string</servLoc>
            <meterNo>string</meterNo>
            <areaCode>string</areaCode>
            <phone>string</phone>
            <accountNumber>string</accountNumber>
          </outageLocation>
          <messageList>
            <message xsi:nil="true" />
            <message xsi:nil="true" />
          </messageList>
          <outageCustomer>
            <custID>string</custID>
            <callBackAC>string</callBackAC>
            <callBackPhone>string</callBackPhone>
            <timeToCall xsi:nil="true" />
            <callBackFlag>boolean</callBackFlag>
            <callBackContactFirstName>string</callBackContactFirstName>
            <callBackContactLastName>string</callBackContactLastName>
            <callBackContactMName>string</callBackContactMName>
            <callBackStatus>On or Off or StillOff or Undialable or MaxDial or NoResponse</callBackStatus>
            <callBackCompletedTime>dateTime</callBackCompletedTime>
            <callBackType>IVR or Manual</callBackType>
            <callRecordID>string</callRecordID>
            <outageEventID>string</outageEventID>
          </outageCustomer>
          <priority>Normal or NeedsAttention or Urgent</priority>
          <percentConfident>integer</percentConfident>
          <problemCode>string</problemCode>
          <resolvedLevel>Meter or Address or Unresolved</resolvedLevel>
        </outageDetectionEvent>
        <outageDetectionEvent>
          <phaseCd>A or B or C or AB or AC or BC or ABC or Unknown</phaseCd>
          <eventTime>dateTime</eventTime>
          <outageEventType>Instantaneous or Outage or Restoration or NoResponse or Inferred or PowerOn or PowerOff</outageEventType>
          <outageDetectDeviceID>string</outageDetectDeviceID>
          <outageDetectDeviceType>Call or CustomerServiceRep or InboundTelephoneDevice or Meter or Other</outageDetectDeviceType>
          <outageLocation>
            <servLoc>string</servLoc>
            <meterNo>string</meterNo>
            <areaCode>string</areaCode>
            <phone>string</phone>
            <accountNumber>string</accountNumber>
          </outageLocation>
          <messageList>
            <message xsi:nil="true" />
            <message xsi:nil="true" />
          </messageList>
          <outageCustomer>
            <custID>string</custID>
            <callBackAC>string</callBackAC>
            <callBackPhone>string</callBackPhone>
            <timeToCall xsi:nil="true" />
            <callBackFlag>boolean</callBackFlag>
            <callBackContactFirstName>string</callBackContactFirstName>
            <callBackContactLastName>string</callBackContactLastName>
            <callBackContactMName>string</callBackContactMName>
            <callBackStatus>On or Off or StillOff or Undialable or MaxDial or NoResponse</callBackStatus>
            <callBackCompletedTime>dateTime</callBackCompletedTime>
            <callBackType>IVR or Manual</callBackType>
            <callRecordID>string</callRecordID>
            <outageEventID>string</outageEventID>
          </outageCustomer>
          <priority>Normal or NeedsAttention or Urgent</priority>
          <percentConfident>integer</percentConfident>
          <problemCode>string</problemCode>
          <resolvedLevel>Meter or Address or Unresolved</resolvedLevel>
        </outageDetectionEvent>
      </ODEvents>
      <transactionId>string</transactionId>
    </ODEventNotification>
  </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:Header>
    <MultiSpeakMsgHeader Version="string" UserID="string" Pwd="string" AppName="string" AppVersion="string" Company="string" CSUnits="feet or meters or USSurveyFeet or other" CoordinateSystem="string" Datum="string" SessionID="string" PreviousSessionID="string" ObjectsRemaining="integer" LastSent="string" xmlns="http://www.multispeak.org/Version_3.0" />
  </soap:Header>
  <soap:Body>
    <ODEventNotificationResponse xmlns="http://www.multispeak.org/Version_3.0">
      <ODEventNotificationResult>
        <errorObject objectID="string" errorString="string" nounType="string" eventTime="dateTime" />
        <errorObject objectID="string" errorString="string" nounType="string" eventTime="dateTime" />
      </ODEventNotificationResult>
    </ODEventNotificationResponse>
  </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 /OMS_IVR_Webservice/OMS_IVR.asmx HTTP/1.1
Host: outagemap.adamselectric.coop
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:Header>
    <MultiSpeakMsgHeader Version="string" UserID="string" Pwd="string" AppName="string" AppVersion="string" Company="string" CSUnits="feet or meters or USSurveyFeet or other" CoordinateSystem="string" Datum="string" SessionID="string" PreviousSessionID="string" ObjectsRemaining="integer" LastSent="string" xmlns="http://www.multispeak.org/Version_3.0" />
  </soap12:Header>
  <soap12:Body>
    <ODEventNotification xmlns="http://www.multispeak.org/Version_3.0">
      <ODEvents>
        <outageDetectionEvent>
          <phaseCd>A or B or C or AB or AC or BC or ABC or Unknown</phaseCd>
          <eventTime>dateTime</eventTime>
          <outageEventType>Instantaneous or Outage or Restoration or NoResponse or Inferred or PowerOn or PowerOff</outageEventType>
          <outageDetectDeviceID>string</outageDetectDeviceID>
          <outageDetectDeviceType>Call or CustomerServiceRep or InboundTelephoneDevice or Meter or Other</outageDetectDeviceType>
          <outageLocation>
            <servLoc>string</servLoc>
            <meterNo>string</meterNo>
            <areaCode>string</areaCode>
            <phone>string</phone>
            <accountNumber>string</accountNumber>
          </outageLocation>
          <messageList>
            <message xsi:nil="true" />
            <message xsi:nil="true" />
          </messageList>
          <outageCustomer>
            <custID>string</custID>
            <callBackAC>string</callBackAC>
            <callBackPhone>string</callBackPhone>
            <timeToCall xsi:nil="true" />
            <callBackFlag>boolean</callBackFlag>
            <callBackContactFirstName>string</callBackContactFirstName>
            <callBackContactLastName>string</callBackContactLastName>
            <callBackContactMName>string</callBackContactMName>
            <callBackStatus>On or Off or StillOff or Undialable or MaxDial or NoResponse</callBackStatus>
            <callBackCompletedTime>dateTime</callBackCompletedTime>
            <callBackType>IVR or Manual</callBackType>
            <callRecordID>string</callRecordID>
            <outageEventID>string</outageEventID>
          </outageCustomer>
          <priority>Normal or NeedsAttention or Urgent</priority>
          <percentConfident>integer</percentConfident>
          <problemCode>string</problemCode>
          <resolvedLevel>Meter or Address or Unresolved</resolvedLevel>
        </outageDetectionEvent>
        <outageDetectionEvent>
          <phaseCd>A or B or C or AB or AC or BC or ABC or Unknown</phaseCd>
          <eventTime>dateTime</eventTime>
          <outageEventType>Instantaneous or Outage or Restoration or NoResponse or Inferred or PowerOn or PowerOff</outageEventType>
          <outageDetectDeviceID>string</outageDetectDeviceID>
          <outageDetectDeviceType>Call or CustomerServiceRep or InboundTelephoneDevice or Meter or Other</outageDetectDeviceType>
          <outageLocation>
            <servLoc>string</servLoc>
            <meterNo>string</meterNo>
            <areaCode>string</areaCode>
            <phone>string</phone>
            <accountNumber>string</accountNumber>
          </outageLocation>
          <messageList>
            <message xsi:nil="true" />
            <message xsi:nil="true" />
          </messageList>
          <outageCustomer>
            <custID>string</custID>
            <callBackAC>string</callBackAC>
            <callBackPhone>string</callBackPhone>
            <timeToCall xsi:nil="true" />
            <callBackFlag>boolean</callBackFlag>
            <callBackContactFirstName>string</callBackContactFirstName>
            <callBackContactLastName>string</callBackContactLastName>
            <callBackContactMName>string</callBackContactMName>
            <callBackStatus>On or Off or StillOff or Undialable or MaxDial or NoResponse</callBackStatus>
            <callBackCompletedTime>dateTime</callBackCompletedTime>
            <callBackType>IVR or Manual</callBackType>
            <callRecordID>string</callRecordID>
            <outageEventID>string</outageEventID>
          </outageCustomer>
          <priority>Normal or NeedsAttention or Urgent</priority>
          <percentConfident>integer</percentConfident>
          <problemCode>string</problemCode>
          <resolvedLevel>Meter or Address or Unresolved</resolvedLevel>
        </outageDetectionEvent>
      </ODEvents>
      <transactionId>string</transactionId>
    </ODEventNotification>
  </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:Header>
    <MultiSpeakMsgHeader Version="string" UserID="string" Pwd="string" AppName="string" AppVersion="string" Company="string" CSUnits="feet or meters or USSurveyFeet or other" CoordinateSystem="string" Datum="string" SessionID="string" PreviousSessionID="string" ObjectsRemaining="integer" LastSent="string" xmlns="http://www.multispeak.org/Version_3.0" />
  </soap12:Header>
  <soap12:Body>
    <ODEventNotificationResponse xmlns="http://www.multispeak.org/Version_3.0">
      <ODEventNotificationResult>
        <errorObject objectID="string" errorString="string" nounType="string" eventTime="dateTime" />
        <errorObject objectID="string" errorString="string" nounType="string" eventTime="dateTime" />
      </ODEventNotificationResult>
    </ODEventNotificationResponse>
  </soap12:Body>
</soap12:Envelope>