PUT api/filters/FilterSet

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Season	integer	None.
Statuses	Collection of string	None.
Sessions	Collection of integer	None.
Programs	Collection of integer	None.
DaysOfOperation	Collection of integer	None.
Family	Collection of string	None.
CcRecipientTypes	Collection of string	None.
BccRecipientTypes	Collection of string	None.
CriteriaSectionData	Collection of CriteriaSection	None.
IncludesAlumniStatus	boolean	None.
SavedFilterSetID	integer	None.
Name	string	None.
ID	integer	None.
RecipientType	string	None.
LastUpdated	string	None.
UpdatedBy	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Season": 1,
  "Statuses": [
    "sample string 1",
    "sample string 2"
  ],
  "Sessions": [
    1,
    2
  ],
  "Programs": [
    1,
    2
  ],
  "DaysOfOperation": [
    1,
    2
  ],
  "Family": [
    "sample string 1",
    "sample string 2"
  ],
  "CcRecipientTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "BccRecipientTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "CriteriaSectionData": [
    {
      "CloseParenCount": 1,
      "ComparisonOperatorID": "sample string 2",
      "ComparisonString": "sample string 3",
      "FieldID": "sample string 4",
      "LogicalOperatorID": "sample string 5",
      "OpenParenCount": 6
    },
    {
      "CloseParenCount": 1,
      "ComparisonOperatorID": "sample string 2",
      "ComparisonString": "sample string 3",
      "FieldID": "sample string 4",
      "LogicalOperatorID": "sample string 5",
      "OpenParenCount": 6
    }
  ],
  "IncludesAlumniStatus": true,
  "SavedFilterSetID": 1,
  "Name": "sample string 2",
  "ID": 3,
  "RecipientType": "sample string 4",
  "LastUpdated": "sample string 5",
  "UpdatedBy": "sample string 6"
}

application/javascript

Sample:

{"Season":1,"Statuses":["sample string 1","sample string 2"],"Sessions":[1,2],"Programs":[1,2],"DaysOfOperation":[1,2],"Family":["sample string 1","sample string 2"],"CcRecipientTypes":["sample string 1","sample string 2"],"BccRecipientTypes":["sample string 1","sample string 2"],"CriteriaSectionData":[{"CloseParenCount":1,"ComparisonOperatorID":"sample string 2","ComparisonString":"sample string 3","FieldID":"sample string 4","LogicalOperatorID":"sample string 5","OpenParenCount":6},{"CloseParenCount":1,"ComparisonOperatorID":"sample string 2","ComparisonString":"sample string 3","FieldID":"sample string 4","LogicalOperatorID":"sample string 5","OpenParenCount":6}],"IncludesAlumniStatus":true,"SavedFilterSetID":1,"Name":"sample string 2","ID":3,"RecipientType":"sample string 4","LastUpdated":"sample string 5","UpdatedBy":"sample string 6"}

application/xml, text/xml

Sample:

<ApiFilterSet xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 2</Name>
  <ID>3</ID>
  <RecipientType>sample string 4</RecipientType>
  <LastUpdated>sample string 5</LastUpdated>
  <UpdatedBy>sample string 6</UpdatedBy>
  <Season>1</Season>
  <Statuses>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Statuses>
  <Sessions>
    <int>1</int>
    <int>2</int>
  </Sessions>
  <Programs>
    <int>1</int>
    <int>2</int>
  </Programs>
  <DaysOfOperation>
    <int>1</int>
    <int>2</int>
  </DaysOfOperation>
  <Family>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Family>
  <CcRecipientTypes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </CcRecipientTypes>
  <BccRecipientTypes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </BccRecipientTypes>
  <CriteriaSectionData>
    <CriteriaSection>
      <CloseParenCount>1</CloseParenCount>
      <ComparisonOperatorID>sample string 2</ComparisonOperatorID>
      <ComparisonString>sample string 3</ComparisonString>
      <FieldID>sample string 4</FieldID>
      <LogicalOperatorID>sample string 5</LogicalOperatorID>
      <OpenParenCount>6</OpenParenCount>
    </CriteriaSection>
    <CriteriaSection>
      <CloseParenCount>1</CloseParenCount>
      <ComparisonOperatorID>sample string 2</ComparisonOperatorID>
      <ComparisonString>sample string 3</ComparisonString>
      <FieldID>sample string 4</FieldID>
      <LogicalOperatorID>sample string 5</LogicalOperatorID>
      <OpenParenCount>6</OpenParenCount>
    </CriteriaSection>
  </CriteriaSectionData>
  <IncludesAlumniStatus>true</IncludesAlumniStatus>
  <SavedFilterSetID>1</SavedFilterSetID>
</ApiFilterSet>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ApiFilterSet'.

Response Information

Resource Description

WebMethodResultOfApiFilterSet

Name	Type	Additional information
Result	ApiFilterSet	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "Season": 1,
    "Statuses": [
      "sample string 1",
      "sample string 2"
    ],
    "Sessions": [
      1,
      2
    ],
    "Programs": [
      1,
      2
    ],
    "DaysOfOperation": [
      1,
      2
    ],
    "Family": [
      "sample string 1",
      "sample string 2"
    ],
    "CcRecipientTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "BccRecipientTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "CriteriaSectionData": [
      {
        "CloseParenCount": 1,
        "ComparisonOperatorID": "sample string 2",
        "ComparisonString": "sample string 3",
        "FieldID": "sample string 4",
        "LogicalOperatorID": "sample string 5",
        "OpenParenCount": 6
      },
      {
        "CloseParenCount": 1,
        "ComparisonOperatorID": "sample string 2",
        "ComparisonString": "sample string 3",
        "FieldID": "sample string 4",
        "LogicalOperatorID": "sample string 5",
        "OpenParenCount": 6
      }
    ],
    "IncludesAlumniStatus": true,
    "SavedFilterSetID": 1,
    "Name": "sample string 2",
    "ID": 3,
    "RecipientType": "sample string 4",
    "LastUpdated": "sample string 5",
    "UpdatedBy": "sample string 6"
  },
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":{"Season":1,"Statuses":["sample string 1","sample string 2"],"Sessions":[1,2],"Programs":[1,2],"DaysOfOperation":[1,2],"Family":["sample string 1","sample string 2"],"CcRecipientTypes":["sample string 1","sample string 2"],"BccRecipientTypes":["sample string 1","sample string 2"],"CriteriaSectionData":[{"CloseParenCount":1,"ComparisonOperatorID":"sample string 2","ComparisonString":"sample string 3","FieldID":"sample string 4","LogicalOperatorID":"sample string 5","OpenParenCount":6},{"CloseParenCount":1,"ComparisonOperatorID":"sample string 2","ComparisonString":"sample string 3","FieldID":"sample string 4","LogicalOperatorID":"sample string 5","OpenParenCount":6}],"IncludesAlumniStatus":true,"SavedFilterSetID":1,"Name":"sample string 2","ID":3,"RecipientType":"sample string 4","LastUpdated":"sample string 5","UpdatedBy":"sample string 6"},"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfApiFilterSet xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <Name>sample string 2</Name>
    <ID>3</ID>
    <RecipientType>sample string 4</RecipientType>
    <LastUpdated>sample string 5</LastUpdated>
    <UpdatedBy>sample string 6</UpdatedBy>
    <Season>1</Season>
    <Statuses>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Statuses>
    <Sessions>
      <int>1</int>
      <int>2</int>
    </Sessions>
    <Programs>
      <int>1</int>
      <int>2</int>
    </Programs>
    <DaysOfOperation>
      <int>1</int>
      <int>2</int>
    </DaysOfOperation>
    <Family>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Family>
    <CcRecipientTypes>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </CcRecipientTypes>
    <BccRecipientTypes>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </BccRecipientTypes>
    <CriteriaSectionData>
      <CriteriaSection>
        <CloseParenCount>1</CloseParenCount>
        <ComparisonOperatorID>sample string 2</ComparisonOperatorID>
        <ComparisonString>sample string 3</ComparisonString>
        <FieldID>sample string 4</FieldID>
        <LogicalOperatorID>sample string 5</LogicalOperatorID>
        <OpenParenCount>6</OpenParenCount>
      </CriteriaSection>
      <CriteriaSection>
        <CloseParenCount>1</CloseParenCount>
        <ComparisonOperatorID>sample string 2</ComparisonOperatorID>
        <ComparisonString>sample string 3</ComparisonString>
        <FieldID>sample string 4</FieldID>
        <LogicalOperatorID>sample string 5</LogicalOperatorID>
        <OpenParenCount>6</OpenParenCount>
      </CriteriaSection>
    </CriteriaSectionData>
    <IncludesAlumniStatus>true</IncludesAlumniStatus>
    <SavedFilterSetID>1</SavedFilterSetID>
  </Result>
</WebMethodResultOfApiFilterSet>