ScomWebService


Click here for a complete list of operations.

WriteParameter

WriteParameter offers a way to control your installation by assigning a value to a parameter of a specific Studer device in your installation. An Installer or QSP User Level Code is necessary to use this service.

Here are some explanations about the service's parameters:

email The email address of your account
pwd The password of your account
installationNumber The identifier of your installation. You can find that number on the xcom portal by editing your installation under the ID label.
device The device you want to reach (for instance XT1).
paramId The parameter identifier that you want to set. You can find a full list of parameter identifiers in the Communication protocol Xcom-232i, available in the Download Center/Software and Updates.
paramPart Indicates if you wish to assign a Value, a Minimum, a Maximum or a Level
paramValue When the "Scom format" of the parameter you want to write is "FLOAT", the value you enter needs to include a dot ('.') as a decimal separator.

As an example, if you want to write parameter 1107 (Maximum current of AC source) with the value "30", you need to enter "30.0".
userLevelCode Installer or QSP, available to qualified clients upon request from Studer Innotec.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
email:
pwd:
installationNumber:
device:
paramId:
paramPart:
paramValue:
userLevelCode:

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 /scomwebservice.asmx HTTP/1.1
Host: portal.studer-innotec.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://xcom.studer-innotec.com/WriteParameter"

<?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>
    <WriteParameter xmlns="https://xcom.studer-innotec.com/">
      <email>string</email>
      <pwd>string</pwd>
      <installationNumber>int</installationNumber>
      <device>XT_Group or XT1 or XT2 or XT3 or XT4 or XT5 or XT6 or XT7 or XT8 or XT9 or XT_L1 or XT_L2 or XT_L3 or VT_Group or VT1 or VT2 or VT3 or VT4 or VT5 or VT6 or VT7 or VT8 or VT9 or VT10 or VT11 or VT12 or VT13 or VT14 or VT15 or XcomMS_Group or XcomMS1 or RCC_Group or LocalXcom or RccXcom or RccXcom2 or RccXcom3 or RccXcom4 or RCC1 or RCC2 or RCC3 or BSP_Group or BSP1 or VS_Group or VS1 or VS2 or VS3 or VS4 or VS5 or VS6 or VS7 or VS8 or VS9 or VS10 or VS11 or VS12 or VS13 or VS14 or VS15</device>
      <paramId>unsignedInt</paramId>
      <paramPart>Value or Minimum or Maximum or Level</paramPart>
      <paramValue>string</paramValue>
      <userLevelCode>int</userLevelCode>
    </WriteParameter>
  </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>
    <WriteParameterResponse xmlns="https://xcom.studer-innotec.com/">
      <WriteParameterResult>
        <ErrorCode>Ok or NotConnected or UnknownError or InvalidFrame or DeviceNotFound or ResponseTimeout or ServiceNotSuported or InvalidServiceArgument or ScomErrorGatewayBusy or TypeNotSupported or ObjectIdNotFound or PropertyNotSupported or InvalidDataLength or PropertyIsReadOnly or InvalidData or DataTooSmall or DataTooBig or WritePropertyFailed or ReadPropertyFailed or AccessDenied or ScomErrorObjectNotSupported or ScomErrorMulticastReadNotSupported or ObjectPropertyInvalid or FileOrDirNotPresent or FileCorrupted or InvalidShellArg</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
      </WriteParameterResult>
    </WriteParameterResponse>
  </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 /scomwebservice.asmx HTTP/1.1
Host: portal.studer-innotec.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>
    <WriteParameter xmlns="https://xcom.studer-innotec.com/">
      <email>string</email>
      <pwd>string</pwd>
      <installationNumber>int</installationNumber>
      <device>XT_Group or XT1 or XT2 or XT3 or XT4 or XT5 or XT6 or XT7 or XT8 or XT9 or XT_L1 or XT_L2 or XT_L3 or VT_Group or VT1 or VT2 or VT3 or VT4 or VT5 or VT6 or VT7 or VT8 or VT9 or VT10 or VT11 or VT12 or VT13 or VT14 or VT15 or XcomMS_Group or XcomMS1 or RCC_Group or LocalXcom or RccXcom or RccXcom2 or RccXcom3 or RccXcom4 or RCC1 or RCC2 or RCC3 or BSP_Group or BSP1 or VS_Group or VS1 or VS2 or VS3 or VS4 or VS5 or VS6 or VS7 or VS8 or VS9 or VS10 or VS11 or VS12 or VS13 or VS14 or VS15</device>
      <paramId>unsignedInt</paramId>
      <paramPart>Value or Minimum or Maximum or Level</paramPart>
      <paramValue>string</paramValue>
      <userLevelCode>int</userLevelCode>
    </WriteParameter>
  </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>
    <WriteParameterResponse xmlns="https://xcom.studer-innotec.com/">
      <WriteParameterResult>
        <ErrorCode>Ok or NotConnected or UnknownError or InvalidFrame or DeviceNotFound or ResponseTimeout or ServiceNotSuported or InvalidServiceArgument or ScomErrorGatewayBusy or TypeNotSupported or ObjectIdNotFound or PropertyNotSupported or InvalidDataLength or PropertyIsReadOnly or InvalidData or DataTooSmall or DataTooBig or WritePropertyFailed or ReadPropertyFailed or AccessDenied or ScomErrorObjectNotSupported or ScomErrorMulticastReadNotSupported or ObjectPropertyInvalid or FileOrDirNotPresent or FileCorrupted or InvalidShellArg</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
      </WriteParameterResult>
    </WriteParameterResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /scomwebservice.asmx/WriteParameter?email=string&pwd=string&installationNumber=string&device=string&paramId=string&paramPart=string&paramValue=string&userLevelCode=string HTTP/1.1
Host: portal.studer-innotec.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<WriteParameterResult xmlns="https://xcom.studer-innotec.com/">
  <ErrorCode>Ok or NotConnected or UnknownError or InvalidFrame or DeviceNotFound or ResponseTimeout or ServiceNotSuported or InvalidServiceArgument or ScomErrorGatewayBusy or TypeNotSupported or ObjectIdNotFound or PropertyNotSupported or InvalidDataLength or PropertyIsReadOnly or InvalidData or DataTooSmall or DataTooBig or WritePropertyFailed or ReadPropertyFailed or AccessDenied or ScomErrorObjectNotSupported or ScomErrorMulticastReadNotSupported or ObjectPropertyInvalid or FileOrDirNotPresent or FileCorrupted or InvalidShellArg</ErrorCode>
  <ErrorMessage>string</ErrorMessage>
</WriteParameterResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /scomwebservice.asmx/WriteParameter HTTP/1.1
Host: portal.studer-innotec.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

email=string&pwd=string&installationNumber=string&device=string&paramId=string&paramPart=string&paramValue=string&userLevelCode=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<WriteParameterResult xmlns="https://xcom.studer-innotec.com/">
  <ErrorCode>Ok or NotConnected or UnknownError or InvalidFrame or DeviceNotFound or ResponseTimeout or ServiceNotSuported or InvalidServiceArgument or ScomErrorGatewayBusy or TypeNotSupported or ObjectIdNotFound or PropertyNotSupported or InvalidDataLength or PropertyIsReadOnly or InvalidData or DataTooSmall or DataTooBig or WritePropertyFailed or ReadPropertyFailed or AccessDenied or ScomErrorObjectNotSupported or ScomErrorMulticastReadNotSupported or ObjectPropertyInvalid or FileOrDirNotPresent or FileCorrupted or InvalidShellArg</ErrorCode>
  <ErrorMessage>string</ErrorMessage>
</WriteParameterResult>