POST api/Project/setComponent
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
ProjectComponentsViewModel| Name | Description | 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. |
Response Formats
application/json, text/json
Sample:
{
"autoCreateScenarios": true,
"propagateDesign": true,
"useComponentPerJob": true,
"useComponentPerStair": true,
"useMarkup": true,
"scenarioList": [
{
"uniqueId": "0c161ea8-dfcd-4cbe-8efa-caf20da6e561",
"name": "sample string 2",
"markup": 3.1,
"discount": 4.1
},
{
"uniqueId": "0c161ea8-dfcd-4cbe-8efa-caf20da6e561",
"name": "sample string 2",
"markup": 3.1,
"discount": 4.1
}
],
"stairList": [
{
"uniqueId": "4ee1eff5-43ae-478a-a4b6-e94cc4c921e5",
"name": "sample string 2",
"markup": 3.1
},
{
"uniqueId": "4ee1eff5-43ae-478a-a4b6-e94cc4c921e5",
"name": "sample string 2",
"markup": 3.1
}
],
"scenarioStairOverride": [
{
"scenarioUniqueId": "83d7b4e8-40e2-4ff6-b737-1fd22efc821d",
"scenarioName": "sample string 2",
"stairName": "sample string 3",
"overrideId": 4
},
{
"scenarioUniqueId": "83d7b4e8-40e2-4ff6-b737-1fd22efc821d",
"scenarioName": "sample string 2",
"stairName": "sample string 3",
"overrideId": 4
}
],
"jobUid": "525e7367-c5ea-4978-b044-9e0d549da053"
}
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>525e7367-c5ea-4978-b044-9e0d549da053</JobUid>
<PropagateDesign>true</PropagateDesign>
<ScenarioList>
<ProjectScenarios>
<Discount>4.1</Discount>
<Markup>3.1</Markup>
<Name>sample string 2</Name>
<UniqueId>0c161ea8-dfcd-4cbe-8efa-caf20da6e561</UniqueId>
</ProjectScenarios>
<ProjectScenarios>
<Discount>4.1</Discount>
<Markup>3.1</Markup>
<Name>sample string 2</Name>
<UniqueId>0c161ea8-dfcd-4cbe-8efa-caf20da6e561</UniqueId>
</ProjectScenarios>
</ScenarioList>
<ScenarioStairOverride>
<ScenarioStairOverrideModel>
<OverrideId>4</OverrideId>
<ScenarioName>sample string 2</ScenarioName>
<ScenarioUniqueId>83d7b4e8-40e2-4ff6-b737-1fd22efc821d</ScenarioUniqueId>
<StairName>sample string 3</StairName>
</ScenarioStairOverrideModel>
<ScenarioStairOverrideModel>
<OverrideId>4</OverrideId>
<ScenarioName>sample string 2</ScenarioName>
<ScenarioUniqueId>83d7b4e8-40e2-4ff6-b737-1fd22efc821d</ScenarioUniqueId>
<StairName>sample string 3</StairName>
</ScenarioStairOverrideModel>
</ScenarioStairOverride>
<StairList>
<ProjectStairs>
<Markup>3.1</Markup>
<Name>sample string 2</Name>
<UniqueId>4ee1eff5-43ae-478a-a4b6-e94cc4c921e5</UniqueId>
</ProjectStairs>
<ProjectStairs>
<Markup>3.1</Markup>
<Name>sample string 2</Name>
<UniqueId>4ee1eff5-43ae-478a-a4b6-e94cc4c921e5</UniqueId>
</ProjectStairs>
</StairList>
<UseComponentPerJob>true</UseComponentPerJob>
<UseComponentPerStair>true</UseComponentPerStair>
<UseMarkup>true</UseMarkup>
</ProjectComponentsViewModel>