POST api/Filters/FilterEdit?id={id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

FiltersParameterDto

Name	Type	Additional information
Name	string	None.
CategoryId	integer	None.
Values	Collection of Collection of string	None.
ExportAll	boolean	None.
ForLabor	boolean	None.
IsDirty	boolean	None.
FilterKeyUid	globally unique identifier	None.
PrevCategoryId	integer	None.
PrevFilterName	string	None.
PrevIsBalustrade	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "categoryId": 2,
  "values": [
    [
      "sample string 1",
      "sample string 2"
    ],
    [
      "sample string 1",
      "sample string 2"
    ]
  ],
  "exportAll": true,
  "forLabor": true,
  "isDirty": true,
  "filterKeyUid": "2b87a842-0f24-443c-8e7a-cfaba3b72b93",
  "prevCategoryId": 7,
  "prevFilterName": "sample string 8",
  "prevIsBalustrade": true
}

application/xml, text/xml

Sample:

<FiltersParameterDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
  <CategoryId>2</CategoryId>
  <ExportAll>true</ExportAll>
  <FilterKeyUid>2b87a842-0f24-443c-8e7a-cfaba3b72b93</FilterKeyUid>
  <ForLabor>true</ForLabor>
  <IsDirty>true</IsDirty>
  <Name>sample string 1</Name>
  <PrevCategoryId>7</PrevCategoryId>
  <PrevFilterName>sample string 8</PrevFilterName>
  <PrevIsBalustrade>true</PrevIsBalustrade>
  <Values xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
    </d2p1:ArrayOfstring>
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
    </d2p1:ArrayOfstring>
  </Values>
</FiltersParameterDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FilterPropertiesViewModel

Name	Type	Additional information
KeyPress	KeyPressParameters	None.
Values	Collection of Collection of string	None.
IsDeleteAll	boolean	None.
Name	TextBoxDto	None.
Category	TextBoxDto	None.
Hidden	CheckBoxDto	None.
IsBalustrade	RadioButtonDto	None.
Properties	ListBoxDto	None.
Results	ListBoxDto	None.
UseAllProperties	CommandButtonDto	None.
UseAllResults	CommandButtonDto	None.
ClearAllProperties	CommandButtonDto	None.
ClearAllResults	CommandButtonDto	None.
PiggyBack	LabelDto	None.

Response Formats

application/json, text/json

Sample:

{
  "name": {
    "text": "sample string 1",
    "visible": true,
    "enabled": true,
    "maxLength": 4,
    "backColor": "sample string 5",
    "locked": true
  },
  "category": {
    "text": "sample string 1",
    "visible": true,
    "enabled": true,
    "maxLength": 4,
    "backColor": "sample string 5",
    "locked": true
  },
  "hidden": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "isBalustrade": {
    "value": true,
    "visible": true,
    "enabled": true
  },
  "properties": {
    "visible": true,
    "enabled": true,
    "items": [
      {
        "value": "sample string 1",
        "selected": true
      },
      {
        "value": "sample string 1",
        "selected": true
      }
    ],
    "selectedIndex": 1
  },
  "results": {
    "visible": true,
    "enabled": true,
    "items": [
      {
        "value": "sample string 1",
        "selected": true
      },
      {
        "value": "sample string 1",
        "selected": true
      }
    ],
    "selectedIndex": 1
  },
  "useAllProperties": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "useAllResults": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "clearAllProperties": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "clearAllResults": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "piggyBack": {
    "caption": "sample string 1",
    "visible": true,
    "enabled": true
  },
  "keyPress": {
    "ctrlKey": true,
    "shiftKey": true,
    "altKey": true
  },
  "values": [
    [
      "sample string 1",
      "sample string 2"
    ],
    [
      "sample string 1",
      "sample string 2"
    ]
  ],
  "isDeleteAll": true
}

application/xml, text/xml

Sample:

<FilterPropertiesViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Category 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>
  </Category>
  <ClearAllProperties xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </ClearAllProperties>
  <ClearAllResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </ClearAllResults>
  <Hidden 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>
  </Hidden>
  <IsBalustrade 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>
  </IsBalustrade>
  <IsDeleteAll>true</IsDeleteAll>
  <KeyPress xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
    <d2p1:AltKey>true</d2p1:AltKey>
    <d2p1:CtrlKey>true</d2p1:CtrlKey>
    <d2p1:ShiftKey>true</d2p1:ShiftKey>
  </KeyPress>
  <Name 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>
  </Name>
  <PiggyBack 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>
  </PiggyBack>
  <Properties 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>
  </Properties>
  <Results 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>
  </Results>
  <UseAllProperties xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </UseAllProperties>
  <UseAllResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </UseAllResults>
  <Values xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
    </d2p1:ArrayOfstring>
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
    </d2p1:ArrayOfstring>
  </Values>
</FilterPropertiesViewModel>