OMS_IVR


Click here for a complete list of operations.

PingURL

CH Pings URL of OA to see if it is alive. Returns errorObject(s) as necessary to communicate application status.(Required)

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

<?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>
    <PingURL xmlns="http://www.multispeak.org/Version_3.0" />
  </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>
    <PingURLResponse xmlns="http://www.multispeak.org/Version_3.0">
      <PingURLResult>
        <errorObject objectID="string" errorString="string" nounType="string" eventTime="dateTime" />
        <errorObject objectID="string" errorString="string" nounType="string" eventTime="dateTime" />
      </PingURLResult>
    </PingURLResponse>
  </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>
    <PingURL xmlns="http://www.multispeak.org/Version_3.0" />
  </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>
    <PingURLResponse xmlns="http://www.multispeak.org/Version_3.0">
      <PingURLResult>
        <errorObject objectID="string" errorString="string" nounType="string" eventTime="dateTime" />
        <errorObject objectID="string" errorString="string" nounType="string" eventTime="dateTime" />
      </PingURLResult>
    </PingURLResponse>
  </soap12:Body>
</soap12:Envelope>