Show / Hide Table of Contents

Class CriteriaFilter

This class is used to build criteria for filtering for use with Ethos resource using version 8 or later. This class extends dynamic object and add methods to generate criteria used for filtering. There are three overloads of WithArray and four overloads of WithSimpleCriteria methods which help you to construct the criteria listed in the example below as well as in the code example above each method.


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

used to generate the criteria dynamically.

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

CriteriaFilter

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

Extension Methods

CriteriaExtension.WithSimpleCriteria(CriteriaFilter, String, Object)
CriteriaExtension.WithSimpleCriteria(CriteriaFilter, String, (String key, Object value))
CriteriaExtension.WithSimpleCriteria(CriteriaFilter, String, (String key, Object value)[])
CriteriaExtension.WithSimpleCriteria(CriteriaFilter, String)
CriteriaExtension.WithArray(CriteriaFilter, String, Object[])
CriteriaExtension.WithArray(CriteriaFilter, String, Dictionary<String, Object>)
CriteriaExtension.WithArray(CriteriaFilter, String, (String key, Object value)[])
FilterUtility.BuildCriteria(CriteriaFilter)
In This Article
Back to top Generated by DocFX