Namespace Ellucian.Ethos.Integration.Client.Proxy
Classes
EthosFilterQueryClient
An EthosProxyClient that provides the ability to submit GET requests supporting filters and/or named queries with support for paging.
EthosProxyClient
An EthosClient used to retrieve data from the Ethos Integration Proxy API.
Supports( but not limited to ) the following functionality:
- Getting data for a given Ethos resource
- Getting an Ethos resource by ID (GUID)
- Getting the page size and/or total count for a resource
Supports paging for data in the following formats:
- List<EthosResponse> a list of EthosResponse objects
- List<
> a list of strings - List<
> a list of Newtonsoft JArray objects
NOTE: None of the methods in this class should be used to bulk load Ethos data. Such is NOT the intent of this SDK.
It is possible that long running process times could result and/or
Pager
Data transfer object (DTO) used primarily within the SDK to easily specify various criteria supporting paging operations. This class follows the builder pattern and contains an inner static Builder class used to build this object with the various attributes/properties.
Enums
Pager.PagingType
Various paging types to determine what kind of paging to be done. This class is built with different attributes depending on the pagingType( howToPage attribute ).