STEMWebService Web Service

STEMWebService

Click here for a complete list of operations.

RunModel

Runs the specified configuration with the given inputs and returns the results. Callers must be able to cope with future changes that add new fields to existing structures.

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

<?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>
    <RunModel 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>
      <seleced_slices>
        <SelectedSlice>
          <chart>string</chart>
          <type>string</type>
          <value>string</value>
        </SelectedSlice>
        <SelectedSlice>
          <chart>string</chart>
          <type>string</type>
          <value>string</value>
        </SelectedSlice>
      </seleced_slices>
      <userName>string</userName>
      <ignoreLogIn>string</ignoreLogIn>
      <addConsolidation>string</addConsolidation>
      <useDatabase>string</useDatabase>
      <scenariosToRun>string</scenariosToRun>
    </RunModel>
  </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>
    <RunModelResponse xmlns="http://www.impliedlogic.com/">
      <RunModelResult>
        <status>int</status>
        <statusString>string</statusString>
        <defaultConsolidation>string</defaultConsolidation>
        <modelValues>
          <ModelValue>
            <name>string</name>
            <value>string</value>
          </ModelValue>
          <ModelValue>
            <name>string</name>
            <value>string</value>
          </ModelValue>
        </modelValues>
        <periodNames>
          <ScenarioPeriodLabels>
            <scenarioName>string</scenarioName>
            <consolidation>string</consolidation>
            <labels xsi:nil="true" />
            <lengths xsi:nil="true" />
            <hasy0>boolean</hasy0>
          </ScenarioPeriodLabels>
          <ScenarioPeriodLabels>
            <scenarioName>string</scenarioName>
            <consolidation>string</consolidation>
            <labels xsi:nil="true" />
            <lengths xsi:nil="true" />
            <hasy0>boolean</hasy0>
          </ScenarioPeriodLabels>
        </periodNames>
        <results>
          <SingleResult>
            <scenario>string</scenario>
            <sensitivity>string</sensitivity>
            <parameter>string</parameter>
            <step>string</step>
            <consolidation>string</consolidation>
            <element>string</element>
            <resultName>string</resultName>
            <unit>string</unit>
            <values xsi:nil="true" />
          </SingleResult>
          <SingleResult>
            <scenario>string</scenario>
            <sensitivity>string</sensitivity>
            <parameter>string</parameter>
            <step>string</step>
            <consolidation>string</consolidation>
            <element>string</element>
            <resultName>string</resultName>
            <unit>string</unit>
            <values xsi:nil="true" />
          </SingleResult>
        </results>
      </RunModelResult>
    </RunModelResponse>
  </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>
    <RunModel 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>
      <seleced_slices>
        <SelectedSlice>
          <chart>string</chart>
          <type>string</type>
          <value>string</value>
        </SelectedSlice>
        <SelectedSlice>
          <chart>string</chart>
          <type>string</type>
          <value>string</value>
        </SelectedSlice>
      </seleced_slices>
      <userName>string</userName>
      <ignoreLogIn>string</ignoreLogIn>
      <addConsolidation>string</addConsolidation>
      <useDatabase>string</useDatabase>
      <scenariosToRun>string</scenariosToRun>
    </RunModel>
  </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>
    <RunModelResponse xmlns="http://www.impliedlogic.com/">
      <RunModelResult>
        <status>int</status>
        <statusString>string</statusString>
        <defaultConsolidation>string</defaultConsolidation>
        <modelValues>
          <ModelValue>
            <name>string</name>
            <value>string</value>
          </ModelValue>
          <ModelValue>
            <name>string</name>
            <value>string</value>
          </ModelValue>
        </modelValues>
        <periodNames>
          <ScenarioPeriodLabels>
            <scenarioName>string</scenarioName>
            <consolidation>string</consolidation>
            <labels xsi:nil="true" />
            <lengths xsi:nil="true" />
            <hasy0>boolean</hasy0>
          </ScenarioPeriodLabels>
          <ScenarioPeriodLabels>
            <scenarioName>string</scenarioName>
            <consolidation>string</consolidation>
            <labels xsi:nil="true" />
            <lengths xsi:nil="true" />
            <hasy0>boolean</hasy0>
          </ScenarioPeriodLabels>
        </periodNames>
        <results>
          <SingleResult>
            <scenario>string</scenario>
            <sensitivity>string</sensitivity>
            <parameter>string</parameter>
            <step>string</step>
            <consolidation>string</consolidation>
            <element>string</element>
            <resultName>string</resultName>
            <unit>string</unit>
            <values xsi:nil="true" />
          </SingleResult>
          <SingleResult>
            <scenario>string</scenario>
            <sensitivity>string</sensitivity>
            <parameter>string</parameter>
            <step>string</step>
            <consolidation>string</consolidation>
            <element>string</element>
            <resultName>string</resultName>
            <unit>string</unit>
            <values xsi:nil="true" />
          </SingleResult>
        </results>
      </RunModelResult>
    </RunModelResponse>
  </soap12:Body>
</soap12:Envelope>