POST api/Project/createJobScenarios

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AutoCreateScenarios	boolean	None.
PropagateDesign	boolean	None.
UseComponentPerJob	boolean	None.
UseComponentPerStair	boolean	None.
UseMarkup	boolean	None.
ScenarioList	Collection of ProjectScenarios	None.
StairList	Collection of ProjectStairs	None.
ScenarioStairOverride	Collection of ScenarioStairOverrideModel	None.
JobUid	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "autoCreateScenarios": true,
  "propagateDesign": true,
  "useComponentPerJob": true,
  "useComponentPerStair": true,
  "useMarkup": true,
  "scenarioList": [
    {
      "uniqueId": "b1c528a9-e87a-4530-a42c-492787331c30",
      "name": "sample string 2",
      "markup": 3.1
    },
    {
      "uniqueId": "b1c528a9-e87a-4530-a42c-492787331c30",
      "name": "sample string 2",
      "markup": 3.1
    }
  ],
  "stairList": [
    {
      "uniqueId": "c557968d-6519-4a1f-88ea-4a4fdf4bc1d4",
      "name": "sample string 2",
      "markup": 3.1
    },
    {
      "uniqueId": "c557968d-6519-4a1f-88ea-4a4fdf4bc1d4",
      "name": "sample string 2",
      "markup": 3.1
    }
  ],
  "scenarioStairOverride": [
    {
      "scenarioUniqueId": "27cb3e64-720e-4a0e-96ed-76a152f42140",
      "scenarioName": "sample string 2",
      "stairName": "sample string 3",
      "overrideId": 4
    },
    {
      "scenarioUniqueId": "27cb3e64-720e-4a0e-96ed-76a152f42140",
      "scenarioName": "sample string 2",
      "stairName": "sample string 3",
      "overrideId": 4
    }
  ],
  "jobUid": "d123333c-6e3b-4718-bd23-5f3ff5e8425c"
}

application/xml, text/xml

Sample:

<ProjectComponentsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <AutoCreateScenarios>true</AutoCreateScenarios>
  <JobUid>d123333c-6e3b-4718-bd23-5f3ff5e8425c</JobUid>
  <PropagateDesign>true</PropagateDesign>
  <ScenarioList>
    <ProjectScenarios>
      <Markup>3.1</Markup>
      <Name>sample string 2</Name>
      <UniqueId>b1c528a9-e87a-4530-a42c-492787331c30</UniqueId>
    </ProjectScenarios>
    <ProjectScenarios>
      <Markup>3.1</Markup>
      <Name>sample string 2</Name>
      <UniqueId>b1c528a9-e87a-4530-a42c-492787331c30</UniqueId>
    </ProjectScenarios>
  </ScenarioList>
  <ScenarioStairOverride>
    <ScenarioStairOverrideModel>
      <OverrideId>4</OverrideId>
      <ScenarioName>sample string 2</ScenarioName>
      <ScenarioUniqueId>27cb3e64-720e-4a0e-96ed-76a152f42140</ScenarioUniqueId>
      <StairName>sample string 3</StairName>
    </ScenarioStairOverrideModel>
    <ScenarioStairOverrideModel>
      <OverrideId>4</OverrideId>
      <ScenarioName>sample string 2</ScenarioName>
      <ScenarioUniqueId>27cb3e64-720e-4a0e-96ed-76a152f42140</ScenarioUniqueId>
      <StairName>sample string 3</StairName>
    </ScenarioStairOverrideModel>
  </ScenarioStairOverride>
  <StairList>
    <ProjectStairs>
      <Markup>3.1</Markup>
      <Name>sample string 2</Name>
      <UniqueId>c557968d-6519-4a1f-88ea-4a4fdf4bc1d4</UniqueId>
    </ProjectStairs>
    <ProjectStairs>
      <Markup>3.1</Markup>
      <Name>sample string 2</Name>
      <UniqueId>c557968d-6519-4a1f-88ea-4a4fdf4bc1d4</UniqueId>
    </ProjectStairs>
  </StairList>
  <UseComponentPerJob>true</UseComponentPerJob>
  <UseComponentPerStair>true</UseComponentPerStair>
  <UseMarkup>true</UseMarkup>
</ProjectComponentsViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProjectComponentsResponseViewModel

Name	Type	Additional information
notification	NotificationDto	None.
JobUidList	Collection of globally unique identifier	None.
JobUid	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "notification": {
    "title": "sample string 1",
    "description": "sample string 2",
    "type": 0
  },
  "jobUidList": [
    "1dae6a5c-6831-4ddb-a603-1261feba3966",
    "0c72e689-0be0-45e9-a692-41be6b143963"
  ],
  "jobUid": "87783378-c10e-457b-a491-e84bc2872145"
}

application/xml, text/xml

Sample:

<ProjectComponentsResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <JobUid>87783378-c10e-457b-a491-e84bc2872145</JobUid>
  <JobUidList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>1dae6a5c-6831-4ddb-a603-1261feba3966</d2p1:guid>
    <d2p1:guid>0c72e689-0be0-45e9-a692-41be6b143963</d2p1:guid>
  </JobUidList>
  <notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Common">
    <d2p1:_x003C_Description_x003E_k__BackingField>sample string 2</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_Title_x003E_k__BackingField>sample string 1</d2p1:_x003C_Title_x003E_k__BackingField>
    <d2p1:_x003C_Type_x003E_k__BackingField>Default</d2p1:_x003C_Type_x003E_k__BackingField>
  </notification>
</ProjectComponentsResponseViewModel>