GET api/Materials/{id}?tabIndex={tabIndex}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| tabIndex | integer |
Required |
|
| id | string |
None. |
Body Parameters
None.
Response Information
Resource Description
MaterialsViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DefaultPartPriceOption | integer |
None. |
|
| DefaultTimberPriceOption | integer |
None. |
|
| EnableTab1 | boolean |
None. |
|
| EnableTab2 | boolean |
None. |
|
| EnableTab3 | boolean |
None. |
|
| EnableTab4 | boolean |
None. |
|
| Total | string |
None. |
|
| BlankSummaryGridColumns | Collection of ColumnViewModel |
None. |
|
| BlankSummaryData | string |
None. |
|
| BlankItemsGridColumns | Collection of ColumnViewModel |
None. |
|
| BlankItemsData | string |
None. |
|
| PartFiltersGridColumns | Collection of ColumnViewModel |
None. |
|
| PartFiltersData | string |
None. |
|
| LooseItemsGridColumns | Collection of ColumnViewModel |
None. |
|
| LooseItemsData | string |
None. |
|
| NewLooseItem | string |
None. |
|
| CurrentLooseItem | string |
None. |
|
| CurrentBlankSummaryItem | string |
None. |
|
| FieldOnEdit | string |
None. |
|
| AllowEdit | boolean |
None. |
|
| MaterialCostTabView | integer |
None. |
|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| ConfirmMessage | string |
None. |
|
| DeleteExistingManualChanges | boolean |
None. |
|
| ClearanceChangePriceLevel | boolean |
None. |
|
| IncludeBlankItems | CheckBoxDto |
None. |
|
| IncludeParts | CheckBoxDto |
None. |
|
| IncludeLineItems | CheckBoxDto |
None. |
|
| ManualMode | CheckBoxDto |
None. |
|
| RoundupOnlyPrice | CheckBoxDto |
None. |
|
| InventoryActive | CheckBoxDto |
None. |
|
| DefaultTimberPriceBuy | RadioButtonDto |
None. |
|
| DefaultTimberPriceSell | RadioButtonDto |
None. |
|
| ProRata1 | LabelDto |
None. |
|
| ProRata2 | LabelDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"includeBlankItems": {
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
"includeParts": {
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
"includeLineItems": {
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
"manualMode": {
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
"roundupOnlyPrice": {
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
"inventoryActive": {
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
"defaultTimberPriceBuy": {
"value": true,
"visible": true,
"enabled": true
},
"defaultTimberPriceSell": {
"value": true,
"visible": true,
"enabled": true
},
"proRata1": {
"caption": "sample string 1",
"visible": true,
"enabled": true
},
"proRata2": {
"caption": "sample string 1",
"visible": true,
"enabled": true
},
"defaultPartPriceOption": 1,
"defaultTimberPriceOption": 2,
"enableTab1": true,
"enableTab2": true,
"enableTab3": true,
"enableTab4": true,
"total": "sample string 7",
"blankSummaryGridColumns": [
{
"name": "sample string 1",
"field": "sample string 2",
"editType": 0,
"visible": true,
"pickList": [
"sample string 1",
"sample string 2"
],
"alignment": 0,
"width": 4,
"editable": true,
"hidden": true
},
{
"name": "sample string 1",
"field": "sample string 2",
"editType": 0,
"visible": true,
"pickList": [
"sample string 1",
"sample string 2"
],
"alignment": 0,
"width": 4,
"editable": true,
"hidden": true
}
],
"blankSummaryData": "sample string 8",
"blankItemsGridColumns": [
{
"name": "sample string 1",
"field": "sample string 2",
"editType": 0,
"visible": true,
"pickList": [
"sample string 1",
"sample string 2"
],
"alignment": 0,
"width": 4,
"editable": true,
"hidden": true
},
{
"name": "sample string 1",
"field": "sample string 2",
"editType": 0,
"visible": true,
"pickList": [
"sample string 1",
"sample string 2"
],
"alignment": 0,
"width": 4,
"editable": true,
"hidden": true
}
],
"blankItemsData": "sample string 9",
"partFiltersGridColumns": [
{
"name": "sample string 1",
"field": "sample string 2",
"editType": 0,
"visible": true,
"pickList": [
"sample string 1",
"sample string 2"
],
"alignment": 0,
"width": 4,
"editable": true,
"hidden": true
},
{
"name": "sample string 1",
"field": "sample string 2",
"editType": 0,
"visible": true,
"pickList": [
"sample string 1",
"sample string 2"
],
"alignment": 0,
"width": 4,
"editable": true,
"hidden": true
}
],
"partFiltersData": "sample string 10",
"looseItemsGridColumns": [
{
"name": "sample string 1",
"field": "sample string 2",
"editType": 0,
"visible": true,
"pickList": [
"sample string 1",
"sample string 2"
],
"alignment": 0,
"width": 4,
"editable": true,
"hidden": true
},
{
"name": "sample string 1",
"field": "sample string 2",
"editType": 0,
"visible": true,
"pickList": [
"sample string 1",
"sample string 2"
],
"alignment": 0,
"width": 4,
"editable": true,
"hidden": true
}
],
"looseItemsData": "sample string 11",
"newLooseItem": "sample string 12",
"currentLooseItem": "sample string 13",
"currentBlankSummaryItem": "sample string 14",
"fieldOnEdit": "sample string 15",
"allowEdit": true,
"materialCostTabView": 17,
"success": true,
"message": "sample string 19",
"confirmMessage": "sample string 20",
"deleteExistingManualChanges": true,
"clearanceChangePriceLevel": true
}
application/xml, text/xml
Sample:
<MaterialsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<AllowEdit>true</AllowEdit>
<BlankItemsData>sample string 9</BlankItemsData>
<BlankItemsGridColumns>
<ColumnViewModel>
<Alignment>Left</Alignment>
<EditType>TextEdit</EditType>
<Editable>true</Editable>
<Field>sample string 2</Field>
<Hidden>true</Hidden>
<Name>sample string 1</Name>
<PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</PickList>
<Visible>true</Visible>
<Width>4</Width>
</ColumnViewModel>
<ColumnViewModel>
<Alignment>Left</Alignment>
<EditType>TextEdit</EditType>
<Editable>true</Editable>
<Field>sample string 2</Field>
<Hidden>true</Hidden>
<Name>sample string 1</Name>
<PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</PickList>
<Visible>true</Visible>
<Width>4</Width>
</ColumnViewModel>
</BlankItemsGridColumns>
<BlankSummaryData>sample string 8</BlankSummaryData>
<BlankSummaryGridColumns>
<ColumnViewModel>
<Alignment>Left</Alignment>
<EditType>TextEdit</EditType>
<Editable>true</Editable>
<Field>sample string 2</Field>
<Hidden>true</Hidden>
<Name>sample string 1</Name>
<PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</PickList>
<Visible>true</Visible>
<Width>4</Width>
</ColumnViewModel>
<ColumnViewModel>
<Alignment>Left</Alignment>
<EditType>TextEdit</EditType>
<Editable>true</Editable>
<Field>sample string 2</Field>
<Hidden>true</Hidden>
<Name>sample string 1</Name>
<PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</PickList>
<Visible>true</Visible>
<Width>4</Width>
</ColumnViewModel>
</BlankSummaryGridColumns>
<ClearanceChangePriceLevel>true</ClearanceChangePriceLevel>
<ConfirmMessage>sample string 20</ConfirmMessage>
<CurrentBlankSummaryItem>sample string 14</CurrentBlankSummaryItem>
<CurrentLooseItem>sample string 13</CurrentLooseItem>
<DefaultPartPriceOption>1</DefaultPartPriceOption>
<DefaultTimberPriceBuy xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Value>true</d2p1:Value>
<d2p1:Visible>true</d2p1:Visible>
</DefaultTimberPriceBuy>
<DefaultTimberPriceOption>2</DefaultTimberPriceOption>
<DefaultTimberPriceSell xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Value>true</d2p1:Value>
<d2p1:Visible>true</d2p1:Visible>
</DefaultTimberPriceSell>
<DeleteExistingManualChanges>true</DeleteExistingManualChanges>
<EnableTab1>true</EnableTab1>
<EnableTab2>true</EnableTab2>
<EnableTab3>true</EnableTab3>
<EnableTab4>true</EnableTab4>
<FieldOnEdit>sample string 15</FieldOnEdit>
<IncludeBlankItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 4</d2p1:Caption>
<d2p1:Checked>true</d2p1:Checked>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</IncludeBlankItems>
<IncludeLineItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 4</d2p1:Caption>
<d2p1:Checked>true</d2p1:Checked>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</IncludeLineItems>
<IncludeParts xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 4</d2p1:Caption>
<d2p1:Checked>true</d2p1:Checked>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</IncludeParts>
<InventoryActive xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 4</d2p1:Caption>
<d2p1:Checked>true</d2p1:Checked>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</InventoryActive>
<LooseItemsData>sample string 11</LooseItemsData>
<LooseItemsGridColumns>
<ColumnViewModel>
<Alignment>Left</Alignment>
<EditType>TextEdit</EditType>
<Editable>true</Editable>
<Field>sample string 2</Field>
<Hidden>true</Hidden>
<Name>sample string 1</Name>
<PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</PickList>
<Visible>true</Visible>
<Width>4</Width>
</ColumnViewModel>
<ColumnViewModel>
<Alignment>Left</Alignment>
<EditType>TextEdit</EditType>
<Editable>true</Editable>
<Field>sample string 2</Field>
<Hidden>true</Hidden>
<Name>sample string 1</Name>
<PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</PickList>
<Visible>true</Visible>
<Width>4</Width>
</ColumnViewModel>
</LooseItemsGridColumns>
<ManualMode xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 4</d2p1:Caption>
<d2p1:Checked>true</d2p1:Checked>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</ManualMode>
<MaterialCostTabView>17</MaterialCostTabView>
<Message>sample string 19</Message>
<NewLooseItem>sample string 12</NewLooseItem>
<PartFiltersData>sample string 10</PartFiltersData>
<PartFiltersGridColumns>
<ColumnViewModel>
<Alignment>Left</Alignment>
<EditType>TextEdit</EditType>
<Editable>true</Editable>
<Field>sample string 2</Field>
<Hidden>true</Hidden>
<Name>sample string 1</Name>
<PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</PickList>
<Visible>true</Visible>
<Width>4</Width>
</ColumnViewModel>
<ColumnViewModel>
<Alignment>Left</Alignment>
<EditType>TextEdit</EditType>
<Editable>true</Editable>
<Field>sample string 2</Field>
<Hidden>true</Hidden>
<Name>sample string 1</Name>
<PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</PickList>
<Visible>true</Visible>
<Width>4</Width>
</ColumnViewModel>
</PartFiltersGridColumns>
<ProRata1 xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 1</d2p1:Caption>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</ProRata1>
<ProRata2 xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 1</d2p1:Caption>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</ProRata2>
<RoundupOnlyPrice xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 4</d2p1:Caption>
<d2p1:Checked>true</d2p1:Checked>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</RoundupOnlyPrice>
<Success>true</Success>
<Total>sample string 7</Total>
</MaterialsViewModel>