GET api/CustomEditorZone?id={id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CustomEditorZoneViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ShowIndex | integer |
None. |
|
| IncludedIndex | integer |
None. |
|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| PartCategories | ListBoxDto |
None. |
|
| OptionIn | Collection of RadioButtonDto |
None. |
|
| OptionShow | Collection of RadioButtonDto |
None. |
|
| JobIndexSpecific | TextBoxDto |
None. |
|
| UnitIndexSpecific | TextBoxDto |
None. |
|
| UnitIndexSpecificLabel | LabelDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"partCategories": {
"visible": true,
"enabled": true,
"items": [
{
"value": "sample string 1",
"selected": true
},
{
"value": "sample string 1",
"selected": true
}
],
"selectedIndex": 1
},
"optionIn": [
{
"value": true,
"visible": true,
"enabled": true
},
{
"value": true,
"visible": true,
"enabled": true
}
],
"optionShow": [
{
"value": true,
"visible": true,
"enabled": true
},
{
"value": true,
"visible": true,
"enabled": true
}
],
"jobIndexSpecific": {
"text": "sample string 1",
"visible": true,
"enabled": true,
"maxLength": 4,
"backColor": "sample string 5",
"locked": true
},
"unitIndexSpecific": {
"text": "sample string 1",
"visible": true,
"enabled": true,
"maxLength": 4,
"backColor": "sample string 5",
"locked": true
},
"unitIndexSpecificLabel": {
"caption": "sample string 1",
"visible": true,
"enabled": true
},
"showIndex": 1,
"includedIndex": 2,
"success": true,
"message": "sample string 4"
}
application/xml, text/xml
Sample:
<CustomEditorZoneViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<IncludedIndex>2</IncludedIndex>
<JobIndexSpecific xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:BackColor>sample string 5</d2p1:BackColor>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Locked>true</d2p1:Locked>
<d2p1:MaxLength>4</d2p1:MaxLength>
<d2p1:Text>sample string 1</d2p1:Text>
<d2p1:Visible>true</d2p1:Visible>
</JobIndexSpecific>
<Message>sample string 4</Message>
<OptionIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:RadioButtonDto>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Value>true</d2p1:Value>
<d2p1:Visible>true</d2p1:Visible>
</d2p1:RadioButtonDto>
<d2p1:RadioButtonDto>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Value>true</d2p1:Value>
<d2p1:Visible>true</d2p1:Visible>
</d2p1:RadioButtonDto>
</OptionIn>
<OptionShow xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:RadioButtonDto>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Value>true</d2p1:Value>
<d2p1:Visible>true</d2p1:Visible>
</d2p1:RadioButtonDto>
<d2p1:RadioButtonDto>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Value>true</d2p1:Value>
<d2p1:Visible>true</d2p1:Visible>
</d2p1:RadioButtonDto>
</OptionShow>
<PartCategories xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Items>
<d2p1:ListBoxItemDto>
<d2p1:Selected>true</d2p1:Selected>
<d2p1:Value>sample string 1</d2p1:Value>
</d2p1:ListBoxItemDto>
<d2p1:ListBoxItemDto>
<d2p1:Selected>true</d2p1:Selected>
<d2p1:Value>sample string 1</d2p1:Value>
</d2p1:ListBoxItemDto>
</d2p1:Items>
<d2p1:SelectedIndex>1</d2p1:SelectedIndex>
<d2p1:Visible>true</d2p1:Visible>
</PartCategories>
<ShowIndex>1</ShowIndex>
<Success>true</Success>
<UnitIndexSpecific xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:BackColor>sample string 5</d2p1:BackColor>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Locked>true</d2p1:Locked>
<d2p1:MaxLength>4</d2p1:MaxLength>
<d2p1:Text>sample string 1</d2p1:Text>
<d2p1:Visible>true</d2p1:Visible>
</UnitIndexSpecific>
<UnitIndexSpecificLabel 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>
</UnitIndexSpecificLabel>
</CustomEditorZoneViewModel>