STEMWebService Web Service

STEMWebService

Click here for a complete list of operations.

FlatRunModel

A version of the RunModel method that returns a flat data structure suitable for use with database tools.

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 /STEMWebService.asmx HTTP/1.1
Host: stem.impliedlogic.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.impliedlogic.com/FlatRunModel"

<?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>
    <FlatRunModel xmlns="http://www.impliedlogic.com/">
      <configId>string</configId>
      <inputs>
        <Input>
          <element>string</element>
          <field>string</field>
          <value>string</value>
        </Input>
        <Input>
          <element>string</element>
          <field>string</field>
          <value>string</value>
        </Input>
      </inputs>
      <userName>string</userName>
      <ignoreLogIn>string</ignoreLogIn>
      <addConsolidation>string</addConsolidation>
      <useDatabase>string</useDatabase>
      <scenariosToRun>string</scenariosToRun>
    </FlatRunModel>
  </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>
    <FlatRunModelResponse xmlns="http://www.impliedlogic.com/">
      <FlatRunModelResult>
        <errors>
          <FlatErrorMessage>
            <status>int</status>
            <statusString>string</statusString>
          </FlatErrorMessage>
          <FlatErrorMessage>
            <status>int</status>
            <statusString>string</statusString>
          </FlatErrorMessage>
        </errors>
        <results>
          <FlatSingleResult>
            <scenario>string</scenario>
            <sensitivity>string</sensitivity>
            <parameter>string</parameter>
            <step>string</step>
            <consolidation>string</consolidation>
            <element>string</element>
            <resultName>string</resultName>
            <periodUnconsolidatedIndex>int</periodUnconsolidatedIndex>
            <periodEnd>double</periodEnd>
            <periodIndex>int</periodIndex>
            <period>string</period>
            <periodLength>int</periodLength>
            <value>double</value>
            <unit>string</unit>
          </FlatSingleResult>
          <FlatSingleResult>
            <scenario>string</scenario>
            <sensitivity>string</sensitivity>
            <parameter>string</parameter>
            <step>string</step>
            <consolidation>string</consolidation>
            <element>string</element>
            <resultName>string</resultName>
            <periodUnconsolidatedIndex>int</periodUnconsolidatedIndex>
            <periodEnd>double</periodEnd>
            <periodIndex>int</periodIndex>
            <period>string</period>
            <periodLength>int</periodLength>
            <value>double</value>
            <unit>string</unit>
          </FlatSingleResult>
        </results>
      </FlatRunModelResult>
    </FlatRunModelResponse>
  </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 /STEMWebService.asmx HTTP/1.1
Host: stem.impliedlogic.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>
    <FlatRunModel xmlns="http://www.impliedlogic.com/">
      <configId>string</configId>
      <inputs>
        <Input>
          <element>string</element>
          <field>string</field>
          <value>string</value>
        </Input>
        <Input>
          <element>string</element>
          <field>string</field>
          <value>string</value>
        </Input>
      </inputs>
      <userName>string</userName>
      <ignoreLogIn>string</ignoreLogIn>
      <addConsolidation>string</addConsolidation>
      <useDatabase>string</useDatabase>
      <scenariosToRun>string</scenariosToRun>
    </FlatRunModel>
  </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>
    <FlatRunModelResponse xmlns="http://www.impliedlogic.com/">
      <FlatRunModelResult>
        <errors>
          <FlatErrorMessage>
            <status>int</status>
            <statusString>string</statusString>
          </FlatErrorMessage>
          <FlatErrorMessage>
            <status>int</status>
            <statusString>string</statusString>
          </FlatErrorMessage>
        </errors>
        <results>
          <FlatSingleResult>
            <scenario>string</scenario>
            <sensitivity>string</sensitivity>
            <parameter>string</parameter>
            <step>string</step>
            <consolidation>string</consolidation>
            <element>string</element>
            <resultName>string</resultName>
            <periodUnconsolidatedIndex>int</periodUnconsolidatedIndex>
            <periodEnd>double</periodEnd>
            <periodIndex>int</periodIndex>
            <period>string</period>
            <periodLength>int</periodLength>
            <value>double</value>
            <unit>string</unit>
          </FlatSingleResult>
          <FlatSingleResult>
            <scenario>string</scenario>
            <sensitivity>string</sensitivity>
            <parameter>string</parameter>
            <step>string</step>
            <consolidation>string</consolidation>
            <element>string</element>
            <resultName>string</resultName>
            <periodUnconsolidatedIndex>int</periodUnconsolidatedIndex>
            <periodEnd>double</periodEnd>
            <periodIndex>int</periodIndex>
            <period>string</period>
            <periodLength>int</periodLength>
            <value>double</value>
            <unit>string</unit>
          </FlatSingleResult>
        </results>
      </FlatRunModelResult>
    </FlatRunModelResponse>
  </soap12:Body>
</soap12:Envelope>