Class CriteriaFilter
This class is used to build criteria for filtering for use with Ethos resource using version 8 or later. This class extends
The data used in the examples is made up and should be replaced with real data in your environment.
Following are examples of the common patterns you will come across to create filters. Please take a look at the EthosFilterQueryClientExamples.
Examples:
Ex1 ?criteria={ "firstName":"Angela" }
Ex2 ?criteria={ "names":{ "lastName":"Smith" } }
Ex3 ?criteria={ "paymentTarget":{ "deduction":{ "deductionType":{ "id":"11111111-1111-1111-1111-111111111112" } } } }
Ex4 ?criteria={ "names":{ "firstName":"Angela", "lastName":"Smith" } }
Ex5 ?criteria={ "statuses":["active","approved"] }
Ex6 ?criteria={ "academicLevels":[{"id":"11111111-1111-1111-1111-111111111111"},{ "id":"11111111-1111-1111-1111-111111111112"}]}
Ex7 ?criteria={ "authors":[{"person":{"id":"11111111-1111-1111-1111-111111111111"}}]}
Ex8 ?criteria={ "names":{ "personalNames":[{ "title":"Mr."},{ "title":"Mr"}]}}
Ex9 ?criteria={ "credentials":[{"type":{"id":"11111111-1111-1111-1111-111111111111"}},{ "value":"bannerId"}]}
Ex10 ?criteria={ "academicLevels":[{"id":"11111111-1111-1111-1111-111111111111","firstName":"John"}]}
Ex11 ?criteria={ "solicitors":[{"solicitor":{"constituent":{"person":{"id":"11111111-1111-1111-1111-111111111111"}}}}]}
Ex12 ?criteria={ "myName":[{"nestedName":{"names":{"firstName":"John"}}},{ "nestedName":{ "names":{ "firstName":"John"} } }]}
Inheritance
System.Object
CriteriaFilter
Namespace: Ellucian.Ethos.Integration.Client.Proxy.Filter
Assembly: Ellucian.Ethos.Integration.dll
Syntax
public class CriteriaFilter : object
Constructors
CriteriaFilter()
This class is used to build criteria for filtering for use with Ethos resource using version 8 or later.
Declaration
public CriteriaFilter()
Properties
CriteriaExpandoObject
Declaration
protected ExpandoObject CriteriaExpandoObject { get; }
Property Value
| Type | Description |
|---|---|
| ExpandoObject |
Operators
Implicit(CriteriaFilter to ExpandoObject)
Custom implicit operator.
Declaration
public static implicit operator ExpandoObject(CriteriaFilter value)
Parameters
| Type | Name | Description |
|---|---|---|
| CriteriaFilter | value |
Returns
| Type | Description |
|---|---|
| ExpandoObject |
Implicit(ExpandoObject to CriteriaFilter)
Custom implicit operator.
Declaration
public static implicit operator CriteriaFilter(ExpandoObject eo)
Parameters
| Type | Name | Description |
|---|---|---|
| ExpandoObject | eo |
Returns
| Type | Description |
|---|---|
| CriteriaFilter |