Service Web Service

Service

Click here for a complete list of operations.

Read

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 /XmlDaSampleServer/Service.asmx HTTP/1.1
Host: opcxml.demo-this.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://opcfoundation.org/webservices/XMLDA/1.0/Read"

<?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>
    <Read xmlns="http://opcfoundation.org/webservices/XMLDA/1.0/">
      <Options RequestDeadline="dateTime" ReturnErrorText="boolean" ReturnDiagnosticInfo="boolean" ReturnItemTime="boolean" ReturnItemPath="boolean" ReturnItemName="boolean" ClientRequestHandle="string" LocaleID="string" />
      <ItemList ItemPath="string" ReqType="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace" MaxAge="int">
        <Items ItemPath="string" ReqType="q1:QName" ItemName="string" ClientItemHandle="string" MaxAge="int" />
        <Items ItemPath="string" ReqType="q1:QName" ItemName="string" ClientItemHandle="string" MaxAge="int" />
      </ItemList>
    </Read>
  </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>
    <ReadResponse xmlns="http://opcfoundation.org/webservices/XMLDA/1.0/">
      <ReadResult RcvTime="dateTime" ReplyTime="dateTime" ClientRequestHandle="string" RevisedLocaleID="string" ServerState="running or failed or noConfig or suspended or test or commFault" />
      <RItemList Reserved="string">
        <Items ItemPath="string" ItemName="string" ClientItemHandle="string" Timestamp="dateTime" ResultID="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace" ValueTypeQualifier="q1:QName">
          <DiagnosticInfo>string</DiagnosticInfo>
          <Value />
          <Quality QualityField="bad or badConfigurationError or badNotConnected or badDeviceFailure or badSensorFailure or badLastKnownValue or badCommFailure or badOutOfService or badWaitingForInitialData or uncertain or uncertainLastUsableValue or uncertainSensorNotAccurate or uncertainEUExceeded or uncertainSubNormal or good or goodLocalOverride" LimitField="none or low or high or constant" VendorField="unsignedByte" />
        </Items>
        <Items ItemPath="string" ItemName="string" ClientItemHandle="string" Timestamp="dateTime" ResultID="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace" ValueTypeQualifier="q1:QName">
          <DiagnosticInfo>string</DiagnosticInfo>
          <Value />
          <Quality QualityField="bad or badConfigurationError or badNotConnected or badDeviceFailure or badSensorFailure or badLastKnownValue or badCommFailure or badOutOfService or badWaitingForInitialData or uncertain or uncertainLastUsableValue or uncertainSensorNotAccurate or uncertainEUExceeded or uncertainSubNormal or good or goodLocalOverride" LimitField="none or low or high or constant" VendorField="unsignedByte" />
        </Items>
      </RItemList>
      <Errors ID="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace">
        <Text>string</Text>
      </Errors>
      <Errors ID="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace">
        <Text>string</Text>
      </Errors>
    </ReadResponse>
  </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 /XmlDaSampleServer/Service.asmx HTTP/1.1
Host: opcxml.demo-this.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>
    <Read xmlns="http://opcfoundation.org/webservices/XMLDA/1.0/">
      <Options RequestDeadline="dateTime" ReturnErrorText="boolean" ReturnDiagnosticInfo="boolean" ReturnItemTime="boolean" ReturnItemPath="boolean" ReturnItemName="boolean" ClientRequestHandle="string" LocaleID="string" />
      <ItemList ItemPath="string" ReqType="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace" MaxAge="int">
        <Items ItemPath="string" ReqType="q1:QName" ItemName="string" ClientItemHandle="string" MaxAge="int" />
        <Items ItemPath="string" ReqType="q1:QName" ItemName="string" ClientItemHandle="string" MaxAge="int" />
      </ItemList>
    </Read>
  </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>
    <ReadResponse xmlns="http://opcfoundation.org/webservices/XMLDA/1.0/">
      <ReadResult RcvTime="dateTime" ReplyTime="dateTime" ClientRequestHandle="string" RevisedLocaleID="string" ServerState="running or failed or noConfig or suspended or test or commFault" />
      <RItemList Reserved="string">
        <Items ItemPath="string" ItemName="string" ClientItemHandle="string" Timestamp="dateTime" ResultID="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace" ValueTypeQualifier="q1:QName">
          <DiagnosticInfo>string</DiagnosticInfo>
          <Value />
          <Quality QualityField="bad or badConfigurationError or badNotConnected or badDeviceFailure or badSensorFailure or badLastKnownValue or badCommFailure or badOutOfService or badWaitingForInitialData or uncertain or uncertainLastUsableValue or uncertainSensorNotAccurate or uncertainEUExceeded or uncertainSubNormal or good or goodLocalOverride" LimitField="none or low or high or constant" VendorField="unsignedByte" />
        </Items>
        <Items ItemPath="string" ItemName="string" ClientItemHandle="string" Timestamp="dateTime" ResultID="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace" ValueTypeQualifier="q1:QName">
          <DiagnosticInfo>string</DiagnosticInfo>
          <Value />
          <Quality QualityField="bad or badConfigurationError or badNotConnected or badDeviceFailure or badSensorFailure or badLastKnownValue or badCommFailure or badOutOfService or badWaitingForInitialData or uncertain or uncertainLastUsableValue or uncertainSensorNotAccurate or uncertainEUExceeded or uncertainSubNormal or good or goodLocalOverride" LimitField="none or low or high or constant" VendorField="unsignedByte" />
        </Items>
      </RItemList>
      <Errors ID="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace">
        <Text>string</Text>
      </Errors>
      <Errors ID="q1:QName" xmlns:q1="http://tempuri.org/SampleNamespace">
        <Text>string</Text>
      </Errors>
    </ReadResponse>
  </soap12:Body>
</soap12:Envelope>