POST api/Values

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ScenarioId	integer	None.
StepId	integer	None.
Token	string	None.
Message	string	None.
ParentScenarios	Collection of ParentScenario	None.
ScenarioHierarchy	Collection of ScenarioHierarchy	None.
IsDataWrite	boolean	None.
VariableType	string	None.
ElementDetailVariableId	integer	None.
IncomingScenarioId	integer	None.
FirstParameters	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ScenarioId": 1,
  "StepId": 2,
  "Token": "sample string 3",
  "Message": "sample string 4",
  "ParentScenarios": [
    {
      "PSScenarioId": 1,
      "LastStepId": 2,
      "NextStepId": 3,
      "Index": 4,
      "ScenarioIsFinished": true
    },
    {
      "PSScenarioId": 1,
      "LastStepId": 2,
      "NextStepId": 3,
      "Index": 4,
      "ScenarioIsFinished": true
    }
  ],
  "ScenarioHierarchy": [
    {
      "BaseScenarioId": 1,
      "ScenarioId": 2,
      "ParentScenarioId": 3,
      "MainScenario": true,
      "NextStepId": 5,
      "Index": 6,
      "isFinished": true
    },
    {
      "BaseScenarioId": 1,
      "ScenarioId": 2,
      "ParentScenarioId": 3,
      "MainScenario": true,
      "NextStepId": 5,
      "Index": 6,
      "isFinished": true
    }
  ],
  "IsDataWrite": true,
  "VariableType": "sample string 6",
  "ElementDetailVariableId": 7,
  "IncomingScenarioId": 8,
  "FirstParameters": "sample string 9"
}

application/xml, text/xml

Sample:

<GetScenarioStep xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChatBiri.Models">
  <ElementDetailVariableId>7</ElementDetailVariableId>
  <FirstParameters>sample string 9</FirstParameters>
  <IncomingScenarioId>8</IncomingScenarioId>
  <IsDataWrite>true</IsDataWrite>
  <Message>sample string 4</Message>
  <ParentScenarios>
    <ParentScenario>
      <Index>4</Index>
      <LastStepId>2</LastStepId>
      <NextStepId>3</NextStepId>
      <PSScenarioId>1</PSScenarioId>
      <ScenarioIsFinished>true</ScenarioIsFinished>
    </ParentScenario>
    <ParentScenario>
      <Index>4</Index>
      <LastStepId>2</LastStepId>
      <NextStepId>3</NextStepId>
      <PSScenarioId>1</PSScenarioId>
      <ScenarioIsFinished>true</ScenarioIsFinished>
    </ParentScenario>
  </ParentScenarios>
  <ScenarioHierarchy>
    <ScenarioHierarchy>
      <BaseScenarioId>1</BaseScenarioId>
      <Index>6</Index>
      <MainScenario>true</MainScenario>
      <NextStepId>5</NextStepId>
      <ParentScenarioId>3</ParentScenarioId>
      <ScenarioId>2</ScenarioId>
      <isFinished>true</isFinished>
    </ScenarioHierarchy>
    <ScenarioHierarchy>
      <BaseScenarioId>1</BaseScenarioId>
      <Index>6</Index>
      <MainScenario>true</MainScenario>
      <NextStepId>5</NextStepId>
      <ParentScenarioId>3</ParentScenarioId>
      <ScenarioId>2</ScenarioId>
      <isFinished>true</isFinished>
    </ScenarioHierarchy>
  </ScenarioHierarchy>
  <ScenarioId>1</ScenarioId>
  <StepId>2</StepId>
  <Token>sample string 3</Token>
  <VariableType>sample string 6</VariableType>
</GetScenarioStep>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ScenarioReturnModel

Name	Type	Additional information
ScenarioHierarchy	Collection of ScenarioHierarchy	None.
ParentScenarios	Collection of ParentScenario	None.
ServiceScenarioReturnMessage	Collection of ServiceScenarioReturnMessage	None.
IsFinished	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ScenarioHierarchy": [
    {
      "BaseScenarioId": 1,
      "ScenarioId": 2,
      "ParentScenarioId": 3,
      "MainScenario": true,
      "NextStepId": 5,
      "Index": 6,
      "isFinished": true
    },
    {
      "BaseScenarioId": 1,
      "ScenarioId": 2,
      "ParentScenarioId": 3,
      "MainScenario": true,
      "NextStepId": 5,
      "Index": 6,
      "isFinished": true
    }
  ],
  "ParentScenarios": [
    {
      "PSScenarioId": 1,
      "LastStepId": 2,
      "NextStepId": 3,
      "Index": 4,
      "ScenarioIsFinished": true
    },
    {
      "PSScenarioId": 1,
      "LastStepId": 2,
      "NextStepId": 3,
      "Index": 4,
      "ScenarioIsFinished": true
    }
  ],
  "ServiceScenarioReturnMessage": [
    {
      "Number": 1,
      "Messages": "sample string 2",
      "ScenarioId": 3,
      "ThisStepId": 4,
      "NextStepId": 5,
      "Token": "sample string 6"
    },
    {
      "Number": 1,
      "Messages": "sample string 2",
      "ScenarioId": 3,
      "ThisStepId": 4,
      "NextStepId": 5,
      "Token": "sample string 6"
    }
  ],
  "IsFinished": true
}

application/xml, text/xml

Sample:

<ScenarioReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChatBiri.Models">
  <IsFinished>true</IsFinished>
  <ParentScenarios>
    <ParentScenario>
      <Index>4</Index>
      <LastStepId>2</LastStepId>
      <NextStepId>3</NextStepId>
      <PSScenarioId>1</PSScenarioId>
      <ScenarioIsFinished>true</ScenarioIsFinished>
    </ParentScenario>
    <ParentScenario>
      <Index>4</Index>
      <LastStepId>2</LastStepId>
      <NextStepId>3</NextStepId>
      <PSScenarioId>1</PSScenarioId>
      <ScenarioIsFinished>true</ScenarioIsFinished>
    </ParentScenario>
  </ParentScenarios>
  <ScenarioHierarchy>
    <ScenarioHierarchy>
      <BaseScenarioId>1</BaseScenarioId>
      <Index>6</Index>
      <MainScenario>true</MainScenario>
      <NextStepId>5</NextStepId>
      <ParentScenarioId>3</ParentScenarioId>
      <ScenarioId>2</ScenarioId>
      <isFinished>true</isFinished>
    </ScenarioHierarchy>
    <ScenarioHierarchy>
      <BaseScenarioId>1</BaseScenarioId>
      <Index>6</Index>
      <MainScenario>true</MainScenario>
      <NextStepId>5</NextStepId>
      <ParentScenarioId>3</ParentScenarioId>
      <ScenarioId>2</ScenarioId>
      <isFinished>true</isFinished>
    </ScenarioHierarchy>
  </ScenarioHierarchy>
  <ServiceScenarioReturnMessage>
    <ServiceScenarioReturnMessage>
      <Messages>sample string 2</Messages>
      <NextStepId>5</NextStepId>
      <Number>1</Number>
      <ScenarioId>3</ScenarioId>
      <ThisStepId>4</ThisStepId>
      <Token>sample string 6</Token>
    </ServiceScenarioReturnMessage>
    <ServiceScenarioReturnMessage>
      <Messages>sample string 2</Messages>
      <NextStepId>5</NextStepId>
      <Number>1</Number>
      <ScenarioId>3</ScenarioId>
      <ThisStepId>4</ThisStepId>
      <Token>sample string 6</Token>
    </ServiceScenarioReturnMessage>
  </ServiceScenarioReturnMessage>
</ScenarioReturnModel>