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"}
Inheritance
System.Object
NamedQueryFilter
Namespace: Ellucian.Ethos.Integration.Client.Proxy.Filter
Assembly: Ellucian.Ethos.Integration.dll
Syntax
public class NamedQueryFilter : object
Constructors
NamedQueryFilter()
This class is used to build criteria for filtering for use with Ethos resource using version 8 or later.
Declaration
public NamedQueryFilter()
NamedQueryFilter(String)
This class is used to build criteria for filtering for use with Ethos resource using version 8 or later.
Declaration
public NamedQueryFilter(string namedQueryLabel)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | namedQueryLabel | Label for the named query. |
Properties
NamedQueryExpandoObject
Declaration
protected ExpandoObject NamedQueryExpandoObject { get; }
Property Value
| Type | Description |
|---|---|
| ExpandoObject |
NamedQueryLabel
Label for the query.
Declaration
public string NamedQueryLabel { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Operators
Implicit(NamedQueryFilter to ExpandoObject)
Custom implicit operator.
Declaration
public static implicit operator ExpandoObject(NamedQueryFilter value)
Parameters
| Type | Name | Description |
|---|---|---|
| NamedQueryFilter | value |
Returns
| Type | Description |
|---|---|
| ExpandoObject |
Implicit(ExpandoObject to NamedQueryFilter)
Custom implicit operator.
Declaration
public static implicit operator NamedQueryFilter(ExpandoObject eo)
Parameters
| Type | Name | Description |
|---|---|---|
| ExpandoObject | eo |
Returns
| Type | Description |
|---|---|
| NamedQueryFilter |