Namespace Ellucian.Ethos.Integration.Client.Proxy.Filter
Classes
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"} } }]}
FilterMap
Plain filter map used to support filtering for resource versions 6 and prior. Contains a Dictionary of key/value pairs for each key/value in the URL filter.
Examples:
//Creates: "persons?firstName=John&lastName=Smith"
string resource = "persons";
string version = "application/vnd.hedtech.integration.v6+json";
string filterKey = "firstName";
string filterValue = "John";
FilterMap filterMap = new FilterMap()
.WithParameterPair( filterKey, filterValue )
.WithParameterPair( "lastName", "Smith" )
.Build();
//Another example
//Creates: "persons?firstName=John"
string resource = "persons";
string version = "application/vnd.hedtech.integration.v6+json";
string filterMapKey = "firstName";
string filterMapValue = "John";
FilterMap filterMap = new FilterMap()
.WithParameterPair( filterMapKey, filterMapValue )
.Build();
FilterUtility
This is a utility class used by Criteria and NamedQuery classes.
NamedQueryExtensions
This class adds extension methods to NamedQueryFilter class.
NamedQueryFilter
This class is used to build named queries for use with Ethos resource using version 8 or later. This class uses
The data used in the examples is made up and should be replaced with real data in your environment.
Following are just examples of the common patterns you will come across to create named queries.
Resource: sections
sections?instructor={"instructor":{"id":"11111111-1111-1111-1111-111111111111"}}
sections?keywordSearch={"keywordSearch":"History"}
sections?searchable={"searchable":"hidden"}
Resource: persons
persons?personFilter= {"personFilter":{"id":"11111111-1111-1111-1111-111111111111"}}
Resource: account-funds-available
account-funds-available?accountSpecification={"accountingString":"11-01-01-00-11111-11111","amount":"2000","balanceOn":"2018-04-01","submittedBy":"11111111-1111-1111-1111-111111111112"}