Show / Hide Table of Contents

Class EthosFilterQueryClient

An EthosProxyClient that provides the ability to submit GET requests supporting filters and/or named queries with support for paging.

Inheritance
System.Object
EthosClient
EthosProxyClient
EthosFilterQueryClient
Inherited Members
EthosProxyClient.DEFAULT_VERSION
EthosProxyClient.DEFAULT_PAGE_SIZE
EthosProxyClient.DEFAULT_MAX_PAGE_SIZE
EthosProxyClient.HDR_DATE
EthosProxyClient.HDR_CONTENT_TYPE
EthosProxyClient.HDR_X_TOTAL_COUNT
EthosProxyClient.HDR_APPLICATION_CONTEXT
EthosProxyClient.HDR_X_MAX_PAGE_SIZE
EthosProxyClient.HDR_X_MEDIA_TYPE
EthosProxyClient.HDR_X_CONTENT_RESTRICTED
EthosProxyClient.HDR_HEDTECH_ETHOS_INTEGRATION_APPLICATION_ID
EthosProxyClient.HDR_HEDTECH_ETHOS_INTEGRATION_APPLICATION_NAME
EthosProxyClient.DATE_FORMAT
EthosProxyClient.ethosResponseConverter
EthosProxyClient.PostAsync(String, String)
EthosProxyClient.PostAsync(String, String, String)
EthosProxyClient.PostAsync(String, JObject)
EthosProxyClient.PostAsync(String, String, JObject)
EthosProxyClient.PutAsync(String, String, String)
EthosProxyClient.PutAsync(String, String, String, String)
EthosProxyClient.PutAsync(String, String, JObject)
EthosProxyClient.PutAsync(String, String, String, JObject)
EthosProxyClient.DeleteAsync(String, String)
EthosProxyClient.GetByIdAsync<T>(String, String, String)
EthosProxyClient.GetAsync<T>(String, String, Int32, Int32)
EthosProxyClient.GetAllPagesAsync<T>(String, String, Int32)
EthosProxyClient.GetPagesAsync<T>(String, String, Int32, Int32)
EthosProxyClient.GetAllPagesFromOffsetAsync<T>(String, String, Int32, Int32)
EthosProxyClient.GetPagesFromOffsetAsync<T>(String, String, Int32, Int32, Int32)
EthosProxyClient.GetRowsAsync<T>(String, String, Int32, Int32)
EthosProxyClient.GetRowsFromOffsetAsync<T>(String, String, Int32, Int32, Int32)
EthosProxyClient.PutAsync<T>(String, T, String, String)
EthosProxyClient.PostAsync<T>(String, T, String)
EthosProxyClient.ConvertEthosResponseContentToType<T>(EthosResponse)
EthosProxyClient.ConvertEthosResponseContentListToType<T>(IEnumerable<EthosResponse>)
EthosProxyClient.GetAsync(String)
EthosProxyClient.GetAsync(String, String)
EthosProxyClient.GetAsStringAsync(String, String)
EthosProxyClient.GetAsJArrayAsync(String, String)
EthosProxyClient.GetAsync(String, String, Int32, Int32)
EthosProxyClient.GetAsStringAsync(String, String, Int32, Int32)
EthosProxyClient.GetAsJArrayAsync(String, String, Int32, Int32)
EthosProxyClient.GetFromOffsetAsync(String, String, Int32)
EthosProxyClient.GetFromOffsetAsStringAsync(String, String, Int32)
EthosProxyClient.GetFromOffsetAsJArrayAsync(String, String, Int32)
EthosProxyClient.GetWithPageSizeAsync(String, String, Int32)
EthosProxyClient.GetWithPageSizeAsStringAsync(String, String, Int32)
EthosProxyClient.GetWithPageSizeAsJArrayAsync(String, String, Int32)
EthosProxyClient.GetAllPagesAsync(String)
EthosProxyClient.GetAllPagesAsync(String, String)
EthosProxyClient.GetAllPagesAsync(String, String, Int32)
EthosProxyClient.GetAllPagesAsStringsAsync(String, String, Int32)
EthosProxyClient.GetAllPagesAsJArraysAsync(String, String, Int32)
EthosProxyClient.GetAllPagesFromOffsetAsync(String, String, Int32, Int32)
EthosProxyClient.GetAllPagesFromOffsetAsStringsAsync(String, String, Int32, Int32)
EthosProxyClient.GetAllPagesFromOffsetAsJArraysAsync(String, String, Int32, Int32)
EthosProxyClient.GetPagesAsync(String, String, Int32, Int32)
EthosProxyClient.GetPagesAsStringsAsync(String, String, Int32, Int32)
EthosProxyClient.GetPagesAsJArraysAsync(String, String, Int32, Int32)
EthosProxyClient.GetPagesFromOffsetAsync(String, String, Int32, Int32, Int32)
EthosProxyClient.GetPagesFromOffsetAsStringsAsync(String, String, Int32, Int32, Int32)
EthosProxyClient.GetPagesFromOffsetAsJArraysAsync(String, String, Int32, Int32, Int32)
EthosProxyClient.GetRowsAsync(String, String, Int32, Int32)
EthosProxyClient.GetRowsAsStringsAsync(String, String, Int32)
EthosProxyClient.GetRowsAsJArrayAsync(String, String, Int32)
EthosProxyClient.GetRowsFromOffsetAsync(String, String, Int32, Int32, Int32)
EthosProxyClient.GetRowsFromOffsetAsStringsAsync(String, String, Int32, Int32)
EthosProxyClient.GetRowsFromOffsetAsJArrayAsync(String, String, Int32, Int32)
EthosProxyClient.GetByIdAsync(String, String, String)
EthosProxyClient.GetAsStringByIdAsync(String, String, String)
EthosProxyClient.GetAsJObjectByIdAsync(String, String, String)
EthosProxyClient.BuildHeadersMap(String)
EthosProxyClient.ShouldDoPaging(Pager, Boolean)
EthosProxyClient.NeedToPage(Int32, Int32)
EthosProxyClient.HandlePagingAsync(Pager)
EthosProxyClient.GetDataFromPagingAsync(Pager)
EthosProxyClient.GetDataFromInitialContent(Pager)
EthosProxyClient.DoPagingForAllAsync(String, String, Int32, Int32)
EthosProxyClient.DoPagingFromOffsetAsync(String, String, String, Int32, Int32, Int32)
EthosProxyClient.DoPagingForNumPagesAsync(String, String, Int32, Int32, Int32)
EthosProxyClient.DoPagingFromOffsetForNumPagesAsync(String, String, Int32, Int32, Int32, Int32)
EthosProxyClient.DoPagingForNumRowsAsync(String, String, Int32, Int32, Int32)
EthosProxyClient.DoPagingFromOffsetForNumRowsAsync(String, String, Int32, Int32, Int32, Int32)
EthosProxyClient.GetHeaderValue(EthosResponse, String)
EthosProxyClient.GetPageSizeAsync(String, String, EthosResponse)
EthosProxyClient.GetMaxPageSizeAsync(String, String, EthosResponse)
EthosProxyClient.GetTotalCountAsync(String, String, EthosResponse)
EthosClient.ApiKey
EthosClient.expirationMinutes
EthosClient.ExpirationMinutes
EthosClient.AutoRefresh
EthosClient.Token
EthosClient.Region
EthosClient.HttpProtocolClientBuilder
EthosClient.EthosResponseBuilder
EthosClient.ResponseHandlerAsync(HttpResponseMessage)
EthosClient.AttachHeaders(HttpClient, Dictionary<String, String>)
EthosClient.GetAccessTokenAsync()
EthosClient.GetNewTokenAsync()
EthosClient.GetHttpClient()
EthosClient.GetStringAsync(Dictionary<String, String>, String)
EthosClient.GetAsync(Dictionary<String, String>, String)
EthosClient.HeadAsync(String)
EthosClient.PostAsync(Dictionary<String, String>, String, String)
EthosClient.PutAsync(Dictionary<String, String>, String, String)
EthosClient.DeleteAsync(Dictionary<String, String>, String)
EthosClient.AddAccessTokenAuthHeaderAsync(Dictionary<String, String>)
Namespace: Ellucian.Ethos.Integration.Client.Proxy
Assembly: Ellucian.Ethos.Integration.dll
Syntax
public class EthosFilterQueryClient : EthosProxyClient

Constructors

EthosFilterQueryClient(String, HttpClient)

Instantiates this class using the given API key and HttpClient.

Declaration
public EthosFilterQueryClient(string apiKey, HttpClient client)
Parameters
Type Name Description
System.String apiKey

A valid API key from Ethos Integration. This is required to be a valid 36 character GUID string. If it is null, empty, or not in a valid GUID format, then an

IllegalArgumentException
will be thrown.

HttpClient client

A HttpClient. If it is null/empty, then an will be thrown.

Fields

CRITERIA_FILTER_PREFIX

Declaration
const string CRITERIA_FILTER_PREFIX = null
Field Value
Type Description
System.String

Methods

DoPagingFromOffsetForQAPIAsync(String, String, String, Int32, Int32, Int32)

Intended to be used internally within the SDK.

Performs paging calculations and operations for QAPI requests.
Declaration
protected async Task<List<EthosResponse>> DoPagingFromOffsetForQAPIAsync(string resourceName, string version, string qapiRequestBody, int totalCount, int pageSize, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

System.String version

The full version header value of the resource used for this POST request.

System.String qapiRequestBody

The body of the request to POST for the given resource.

System.Int32 totalCount

The total count of rows for the given resource.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<List<EthosResponse>>

Collection of EthosResponse with content.

EncodeString(String)

Used internally by the SDK.

Encodes the given criteriaFilterStr. Supports criteria filter strings that begin with the CRITERIA_FILTER_PREFIX value "?criteria=", and also those that do not. Encodes only the JSON criteria portion of the filter string, removing the CRITERIA_FILTER_PREFIX portion if the filter string starts with it. If the filter string does not start with the CRITERIA_FILTER_PREFIX, the criteriaFilterStr string is simply encoded.

Returns a criteria filter string that begins with the CRITERIA_FILTER_PREFIX, with the JSON filter portion of the string encoded. Uses UTF-8 encoding.

Declaration
static string EncodeString(string criteriaFilterStr)
Parameters
Type Name Description
System.String criteriaFilterStr

The criteria filter string to encode.

Returns
Type Description
System.String

A criteria filter string beginning with the CRITERIA_FILTER_PREFIX with the JSON filter syntax portion of the string encoded in UTF-8.

GetEthosResponseAsync(String, String, String)

Gets Ethos Response.

Declaration
async Task<EthosResponse> GetEthosResponseAsync(string resourceName, string version, string criteria)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.String criteria

This can be CriteriaFilter or NamedQuery.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according
to the requested version and filter of the resource.

GetJsonSerializerSettings()

Gets JsonSerializerSettings with date format.

Declaration
static JsonSerializerSettings GetJsonSerializerSettings()
Returns
Type Description
JsonSerializerSettings

Returns JsonSerializerSettings with yyyy'-'MM'-'dd'T'HH':'mm':'ssK date format and ignores null values.

GetPagesFromOffsetWithCriteriaFilterAsync(String, CriteriaFilter, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter. The page size is determined to be the length of the returned response of the request using the criteria filter. The default version of the resource is used.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithCriteriaFilterAsync(string resourceName, CriteriaFilter criteria, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithCriteriaFilterAsync(String, CriteriaFilter, Int32, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter and page size for the given version. The default version of the resource is used.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithCriteriaFilterAsync(string resourceName, CriteriaFilter criteria, int pageSize, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithCriteriaFilterAsync(String, String, CriteriaFilter, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter for the given version. The page size is determined to be the length of the returned response of the request using the criteria filter.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithCriteriaFilterAsync(string resourceName, string version, CriteriaFilter criteria, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithCriteriaFilterAsync(String, String, CriteriaFilter, Int32, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithCriteriaFilterAsync(string resourceName, string version, CriteriaFilter criteria, int pageSize, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithCriteriaFilterAsync<T>(String, CriteriaFilter, String, Int32, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithCriteriaFilterAsync<T>(string resourceName, CriteriaFilter criteria, string version = "", int pageSize = 0, int offset = 0)
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetPagesFromOffsetWithFilterMapAsync(String, String, FilterMap, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified filter map and page size for the given version. The page size is determined to be the length of the returned response of the request using the filter map.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithFilterMapAsync(string resourceName, string version, FilterMap filterMap, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

FilterMap filterMap

A previously built FilterMap containing the filter parameters used in the request URL. A simple call to filterMap.tostring() should output the criteria filter portion of the request URL, e.g:

?firstName=John&lastName=Smith
.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithFilterMapAsync(String, String, FilterMap, Int32, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified filter map and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithFilterMapAsync(string resourceName, string version, FilterMap filterMap, int pageSize, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

FilterMap filterMap

A previously built FilterMap containing the filter parameters used in the request URL. A simple call to filterMap.tostring() should output the criteria filter portion of the request URL, e.g:

?firstName=John&lastName=Smith
.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithFilterMapAsync<T>(String, FilterMap, String, Int32, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified filter map and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithFilterMapAsync<T>(string resourceName, FilterMap filterMap, string version = "", int pageSize = 0, int offset = 0)
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

FilterMap filterMap

A previously built FilterMap containing the filter parameters used in the request URL. A simple call to filterMap.tostring() should output the criteria filter portion of the request URL, e.g:

?firstName=John&lastName=Smith
.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the IEnumerable<EthosResponse> returned specified by caller.

GetPagesFromOffsetWithNamedQueryFilterAsync(String, NamedQueryFilter, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified namedQueryFilter filter. The page size is determined to be the length of the returned response of the request using the namedQueryFilter filter. The default version of the resource is used.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithNamedQueryFilterAsync(string resourceName, NamedQueryFilter namedQueryFilter, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

NamedQueryFilter namedQueryFilter
System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithNamedQueryFilterAsync(String, NamedQueryFilter, Int32, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified namedQueryFilter and page size for the given version. The default version of the resource is used.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithNamedQueryFilterAsync(string resourceName, NamedQueryFilter namedQueryFilter, int pageSize, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithNamedQueryFilterAsync(String, String, NamedQueryFilter, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified namedQueryFilter filter for the given version. The page size is determined to be the length of the returned response of the request using the namedQueryFilter filter.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithNamedQueryFilterAsync(string resourceName, string version, NamedQueryFilter namedQueryFilter, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithNamedQueryFilterAsync(String, String, NamedQueryFilter, Int32, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified namedQueryFilter and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithNamedQueryFilterAsync(string resourceName, string version, NamedQueryFilter namedQueryFilter, int pageSize, int offset)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesFromOffsetWithNamedQueryFilterAsync<T>(String, NamedQueryFilter, String, Int32, Int32)

Gets all the pages for a given resource beginning at the given offset index, using the specified namedQueryFilter and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithNamedQueryFilterAsync<T>(string resourceName, NamedQueryFilter namedQueryFilter, string version = "", int pageSize = 0, int offset = 0)
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetPagesFromOffsetWithQAPIAsync(String, JObject, String, Int32, Int32)

Gets the total count of resources available using the given criteriaFilter. Gets the pages for a given resource beginning at the given offset index, using the specified QAPI request body and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithQAPIAsync(string resourceName, JObject qapiRequestBody, string version = "", int pageSize = 0, int offset = 0)
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

JObject qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The full version header value of the resource used for this POST request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

A list of EthosResponses where each EthosResponse contains a page of data. If paging is not required based on the given pageSize and total count( from using the filter), the returned list will only contain one EthosResponse.

GetPagesFromOffsetWithQAPIAsync(String, String, String, Int32, Int32)

Gets the total count of resources available using the given criteriaFilter. Gets the pages for a given resource beginning at the given offset index, using the specified QAPI request body and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithQAPIAsync(string resourceName, string qapiRequestBody, string version = "", int pageSize = 0, int offset = 0)
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

System.String qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The full version header value of the resource used for this POST request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

A list of EthosResponses where each EthosResponse contains a page of data. If paging is not required based on the given pageSize and total count( from using the filter), the returned list will only contain one EthosResponse.

GetPagesFromOffsetWithQAPIAsync<T>(String, T, String, Int32, Int32)

Gets the total count of resources available using the given type T. Gets the pages for a given resource beginning at the given offset index, using the specified QAPI request body and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesFromOffsetWithQAPIAsync<T>(string resourceName, T qapiRequestBody, string version = "", int pageSize = 0, int offset = 0)
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

T qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The full version header value of the resource used for this POST request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

System.Int32 offset

The 0 based index from which to begin paging for the given resource.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

A list of EthosResponses where each EthosResponse contains a page of data. If paging is not required based on the given pageSize and total count( from using the filter), the returned list will only contain one EthosResponse.

Type Parameters
Name Description
T

Request type.

GetPagesWithCriteriaFilterAsync(String, CriteriaFilter)

Gets all the pages for a given resource using the specified criteria filter. Uses the default version of the resource, and the page size is derived from the length of the returned response of the request using the criteria filter.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithCriteriaFilterAsync(string resourceName, CriteriaFilter criteria)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL. A simple call to criteriaFilter.BuildCriteria() should output the criteria filter portion of the request URL, e.g:

?criteria={"names":[{"firstName":"John"}]}
.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithCriteriaFilterAsync(String, CriteriaFilter, Int32)

Gets all the pages for a given resource using the specified criteria filter and page size. The default version of the resource is used.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithCriteriaFilterAsync(string resourceName, CriteriaFilter criteria, int pageSize)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithCriteriaFilterAsync(String, String, CriteriaFilter)

Gets all the pages for a given resource using the specified criteria filter for the given version. Uses the default page size, which is the length of the returned response of the request using the criteria filter.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithCriteriaFilterAsync(string resourceName, string version, CriteriaFilter criteria)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithCriteriaFilterAsync(String, String, CriteriaFilter, Int32)

Gets all the pages for a given resource using the specified criteria filter and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithCriteriaFilterAsync(string resourceName, string version, CriteriaFilter criteria, int pageSize)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithCriteriaFilterAsync<T>(String, CriteriaFilter, String, Int32)

Gets all the pages for a given resource using the specified criteria filter and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithCriteriaFilterAsync<T>(string resourceName, CriteriaFilter criteria, string version = "", int pageSize = 0)
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetPagesWithFilterMapAsync(String, String, FilterMap)

Gets all the pages for a given resource using the specified filter map and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithFilterMapAsync(string resourceName, string version, FilterMap filterMap)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

FilterMap filterMap

A previously built FilterMap containing the filter parameters used in the request URL. A simple call to filterMap.tostring() should output the criteria filter portion of the request URL, e.g:

?firstName=John&lastName=Smith
.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithFilterMapAsync(String, String, FilterMap, Int32)

Gets all the pages for a given resource using the specified filter map and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithFilterMapAsync(string resourceName, string version, FilterMap filterMap, int pageSize)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

FilterMap filterMap

A previously built FilterMap containing the filter parameters used in the request URL. A simple call to filterMap.tostring() should output the criteria filter portion of the request URL, e.g:

?firstName=John&lastName=Smith
.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithFilterMapAsync<T>(String, FilterMap, String, Int32)

Gets all the pages for a given resource using the specified filter map and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithFilterMapAsync<T>(string resourceName, FilterMap filterMap, string version = "", int pageSize = 0)
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

FilterMap filterMap

A previously built FilterMap containing the filter parameters used in the request URL.

The desired resource version header to use, as provided in the HTTP Accept Header of the request. A simple call to filterMap.tostring() should output the criteria filter portion of the request URL, e.g:
?firstName=John&lastName=Smith
.
System.String version
System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetPagesWithNamedQueryFilterAsync(String, NamedQueryFilter)

Gets all the pages for a given resource using the specified namedQueryFilter filter. Uses the default version of the resource, and the page size is derived from the length of the returned response of the request using the namedQueryFilter filter.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithNamedQueryFilterAsync(string resourceName, NamedQueryFilter namedQueryFilter)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL. A simple call to namedQueryFilter.BuildNamedQuery() should output the namedQueryFilter filter portion of the request URL.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithNamedQueryFilterAsync(String, NamedQueryFilter, Int32)

Gets all the pages for a given resource using the specified namedQueryFilter filter and page size. The default version of the resource is used.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithNamedQueryFilterAsync(string resourceName, NamedQueryFilter namedQueryFilter, int pageSize)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithNamedQueryFilterAsync(String, String, NamedQueryFilter)

Gets all the pages for a given resource using the specified namedQueryFilter filter for the given version. Uses the default page size, which is the length of the returned response of the request using the namedQueryFilter filter.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithNamedQueryFilterAsync(string resourceName, string version, NamedQueryFilter namedQueryFilter)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithNamedQueryFilterAsync(String, String, NamedQueryFilter, Int32)

Gets all the pages for a given resource using the specified namedQueryFilter filter and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithNamedQueryFilterAsync(string resourceName, string version, NamedQueryFilter namedQueryFilter, int pageSize)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter named query used in the request URL.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetPagesWithNamedQueryFilterAsync<T>(String, NamedQueryFilter, String, Int32)

Gets all the pages for a given resource using the specified namedQueryFilter filter and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithNamedQueryFilterAsync<T>(string resourceName, NamedQueryFilter namedQueryFilter, string version = "", int pageSize = 0)
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter named query used in the request URL.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

An

List<EthosResponse>
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetPagesWithQAPIAsync(String, JObject, String, Int32)

Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithQAPIAsync(string resourceName, JObject qapiRequestBody, string version = "", int pageSize = 0)
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

JObject qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The full version header value of the resource used for this POST request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

A list of EthosResponses where each EthosResponse contains a page of data. If paging is not required based on the given pageSize and total count( from using the filter), the returned list will only contain one EthosResponse.

GetPagesWithQAPIAsync(String, String, String, Int32)

Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithQAPIAsync(string resourceName, string qapiRequestBody, string version = "", int pageSize = 0)
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

System.String qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The full version header value of the resource used for this POST request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

A list of EthosResponses where each EthosResponse contains a page of data. If paging is not required based on the given pageSize and total count( from using the filter), the returned list will only contain one EthosResponse.

GetPagesWithQAPIAsync<T>(String, T, String, Int32)

Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body and page size for the given version.

Declaration
public async Task<IEnumerable<EthosResponse>> GetPagesWithQAPIAsync<T>(string resourceName, T qapiRequestBody, string version = "", int pageSize = 0)
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

T qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The full version header value of the resource used for this POST request.

System.Int32 pageSize

The size (number of rows) of each page returned in the list.

Returns
Type Description
Task<IEnumerable<EthosResponse>>

A list of EthosResponses where each EthosResponse contains a page of data. If paging is not required based on the given pageSize and total count( from using the filter), the returned list will only contain one EthosResponse.

Type Parameters
Name Description
T

Request type.

GetTotalCountAsync(String, CriteriaFilter, String)

Gets the total count of resources available using the given criteriaFilter.

Declaration
public async Task<int> GetTotalCountAsync(string resourceName, CriteriaFilter criteria, string version = "")
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<System.Int32>

The number of resource instances available when making a GET request using the given criteriaFilter, or 0 if the given resourceName or criteriaFilter is null.

GetTotalCountAsync(String, FilterMap, String)

Gets the total count of resources available using the given filterMap.

Declaration
public async Task<int> GetTotalCountAsync(string resourceName, FilterMap filterMap, string version = "")
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

FilterMap filterMap

A previously built FilterMap containing the filter parameters used in the request URL. A simple call to filterMap.Tostring() should output the criteria filter portion of the request URL, e.g:

?firstName=John&lastName=Smith
.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<System.Int32>

The number of resource instances available when making a GET request using the given criteriaFilter, or 0 if the given resourceName or criteriaFilter is null.

GetTotalCountAsync(String, NamedQueryFilter, String)

Gets the total count of resources available using the given namedQueryFilter.

Declaration
public async Task<int> GetTotalCountAsync(string resourceName, NamedQueryFilter namedQueryFilter, string version = "")
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<System.Int32>

The number of resource instances available when making a GET request using the given namedQueryFilter, or 0 if the given resourceName or namedQueryFilter is null.

GetTotalCountAsync(String, JObject, String)

Gets the total count of resources available using the given QAPI request body.

Declaration
public async Task<int> GetTotalCountAsync(string resourceName, JObject qapiRequestBody, string version = "")
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

JObject qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<System.Int32>

The number of resource instances available when making a GET request using the given namedQueryFilter, or 0 if the given resourceName or namedQueryFilter is null.

GetTotalCountAsync(String, String, String)

Gets the total count of resources available using the given QAPI request body.

Declaration
public async Task<int> GetTotalCountAsync(string resourceName, string qapiRequestBody, string version = "")
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<System.Int32>

The number of resource instances available when making a GET request using the given namedQueryFilter, or 0 if the given resourceName or namedQueryFilter is null.

GetTotalCountAsync<T>(String, T, String)

Gets the total count of resources available using the given QAPI request body.

Declaration
public async Task<int> GetTotalCountAsync<T>(string resourceName, T qapiRequestBody, string version = "")
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

T qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<System.Int32>

The number of resource instances available when making a GET request using the given namedQueryFilter, or 0 if the given resourceName or namedQueryFilter is null.

Type Parameters
Name Description
T

GetWithCriteriaFilterAsync(String, CriteriaFilter)

Gets a page of data for the given resource by name with the given filter. Uses the default version of the resource. Makes a non-filter API request if the given criteriaFilter is null. A simple call to criteriaFilter.BuildCriteria() should output the criteria filter portion of the request URL, e.g:

?criteria={"names":[{"firstName":"John"}]}
.

Declaration
public async Task<EthosResponse> GetWithCriteriaFilterAsync(string resourceName, CriteriaFilter criteria)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL. A simple call to criteriaFilter.BuildCriteria() should output the criteria filter portion of the request URL, e.g:

?criteria={"names":[{"firstName":"John"}]}
.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetWithCriteriaFilterAsync(String, String)

Gets a page of data for the given resource with the given filter. Uses the default version of the resource. Makes a non-filter API request if the given criteriaFilterStr is null or blank.

Declaration
public async Task<EthosResponse> GetWithCriteriaFilterAsync(string resourceName, string criteriaFilterStr)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String criteriaFilterStr

The string resource filter in JSON format contained in the URL, e.g:

?criteria={"names":[{"firstName":"John"}]}

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.
to the requested version and filter of the resource.

GetWithCriteriaFilterAsync(String, String, CriteriaFilter)

Gets a page of data for the given resource by name and version with the given filter.

Declaration
public async Task<EthosResponse> GetWithCriteriaFilterAsync(string resourceName, string version, CriteriaFilter criteria)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL. A simple call to criteriaFilter.BuildCriteria() should output the criteria filter portion of the request URL, e.g:

?criteria={"names":[{"firstName":"John"}]}
.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.
to the requested version and filter of the resource.

GetWithCriteriaFilterAsync(String, String, String)

Gets a page of data for the given resource by name and version with the given filter.

Declaration
public async Task<EthosResponse> GetWithCriteriaFilterAsync(string resourceName, string version, string criteriaFilterStr)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.String criteriaFilterStr

The string resource filter in JSON format contained in the URL, e.g:

?criteria={"names":[{"firstName":"John"}]}

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according
to the requested version and filter of the resource.

GetWithCriteriaFilterAsync<T>(String, CriteriaFilter, String)

Gets a page of data for the given resource by name and version with the given filter.

Declaration
public async Task<EthosResponse> GetWithCriteriaFilterAsync<T>(string resourceName, CriteriaFilter criteria, string version = "")
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

CriteriaFilter criteria

A previously built Criteria containing the filter criteria used in the request URL.

The desired resource version header to use, as provided in the HTTP Accept Header of the request. A simple call to criteriaFilter.BuildCriteria() should output the criteria filter portion of the request URL, e.g:
?criteria={"names":[{"firstName":"John"}]}
.
System.String version
Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.
to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetWithCriteriaFilterAsync<T>(String, String, String)

Gets a page of data for the given resource by name and version with the given filter.

Declaration
public async Task<EthosResponse> GetWithCriteriaFilterAsync<T>(string resourceName, string criteriaFilterStr, string version = "")
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String criteriaFilterStr

The string resource filter in JSON format contained in the URL, e.g:

?criteria={"names":[{"firstName":"John"}]}

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according
to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetWithFilterMapAsync(String, String, FilterMap)

Submits a GET request for the given resource and version using the given filterMap. The filterMap is intended to support the filter syntax for resources versions 7 and older. A FilterMap contains a map of one or many filter parameter pair(s). An example of a filterMap string indicating the contents of the map is:

?firstName=James
.

This is NOT intended to be used for resource versions after version 7 and/or for criteria filters.

Declaration
public async Task<EthosResponse> GetWithFilterMapAsync(string resourceName, string version, FilterMap filterMap)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

FilterMap filterMap

A string containing the filter syntax used for request URL filters with resource versions 7 or older.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetWithFilterMapAsync(String, String, String)

Submits a GET request for the given resource and version using the given filterMapStr. The filterMapStr is intended to support the filter syntax for resources versions 7 and older. An example of a filterMapStr is:

?firstName=James
.

This is NOT intended to be used for resource versions after version 7 and/or for criteria filters.

Declaration
public async Task<EthosResponse> GetWithFilterMapAsync(string resourceName, string version, string filterMapStr)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.String filterMapStr

A string containing the filter syntax used for request URL filters with resource versions 7 or older.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetWithFilterMapAsync<T>(String, FilterMap, String)

Submits a GET request for the given resource and version using the given filterMap. The filterMap is intended to support the filter syntax for resources versions 7 and older. A FilterMap contains a map of one or many filter parameter pair(s). An example of a filterMap string indicating the contents of the map is:

?firstName=James
.

This is NOT intended to be used for resource versions after version 7 and/or for criteria filters.

Declaration
public async Task<EthosResponse> GetWithFilterMapAsync<T>(string resourceName, FilterMap filterMap, string version = "")
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

FilterMap filterMap

A string containing the filter syntax used for request URL filters with resource versions 7 or older.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetWithFilterMapAsync<T>(String, String, String)

Submits a GET request for the given resource and version using the given filterMapStr. The filterMapStr is intended to support the filter syntax for resources versions 7 and older. An example of a filterMapStr is:

?firstName=James
.

This is NOT intended to be used for resource versions after version 7 and/or for criteria filters.

Declaration
public async Task<EthosResponse> GetWithFilterMapAsync<T>(string resourceName, string filterMapStr, string version = "")
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String filterMapStr

A string containing the filter syntax used for request URL filters with resource versions 7 or older.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetWithNamedQueryFilterAsync(String, NamedQueryFilter)

Gets a page of data for the given resource by name with the given filter. Uses the default version of the resource. Makes a non-filter API request if the given criteriaFilter is null. A simple call to criteriaFilter.BuildCriteria() should output the criteria filter portion of the request URL.

Declaration
public async Task<EthosResponse> GetWithNamedQueryFilterAsync(string resourceName, NamedQueryFilter namedQueryFilter)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL. A simple call to namedQueryFilter.BuildNamedQuery() should output the criteria filter portion of the request URL, e.g:

?criteria={"names":[{"firstName":"John"}]}
.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetWithNamedQueryFilterAsync(String, String)

Gets a page of data for the given resource with the given filter. Uses the default version of the resource. Makes a non-filter API request if the given namedQueryFilterStr is null or blank.

Declaration
public async Task<EthosResponse> GetWithNamedQueryFilterAsync(string resourceName, string namedQueryFilterStr)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String namedQueryFilterStr

The string resource filter in JSON format contained in the URL, e.g:

?criteria={"names":[{"firstName":"John"}]}

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.
to the requested version and filter of the resource.

GetWithNamedQueryFilterAsync(String, String, NamedQueryFilter)

Gets a page of data for the given resource by name and version with the given filter.

Declaration
public async Task<EthosResponse> GetWithNamedQueryFilterAsync(string resourceName, string version, NamedQueryFilter namedQueryFilter)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL. A simple call to namedQueryFilter.BuildNamedQuery() should output the named query portion of the request URL.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.
to the requested version and filter of the resource.

GetWithNamedQueryFilterAsync(String, String, String)

Gets a page of data for the given resource by name and version with the given filter.

Declaration
public async Task<EthosResponse> GetWithNamedQueryFilterAsync(string resourceName, string version, string namedQueryFilterStr)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.String namedQueryFilterStr

The string resource filter in JSON format contained in the URL.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according
to the requested version and filter of the resource.

GetWithNamedQueryFilterAsync<T>(String, NamedQueryFilter, String)

Gets a page of data for the given resource by name and version with the given filter.

Declaration
public async Task<EthosResponse> GetWithNamedQueryFilterAsync<T>(string resourceName, NamedQueryFilter namedQueryFilter, string version = "")
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

NamedQueryFilter namedQueryFilter

A previously built namedQueryFilter containing the filter used in the request URL.

The desired resource version header to use, as provided in the HTTP Accept Header of the request. A simple call to namedQueryFilter.BuildNamedQuery() should output the named query portion of the request URL.
System.String version
Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.
to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetWithNamedQueryFilterAsync<T>(String, String, String)

Gets a page of data for the given resource by name and version with the given filter.

Declaration
public async Task<EthosResponse> GetWithNamedQueryFilterAsync<T>(string resourceName, string namedQueryFilterStr, string version = "")
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String namedQueryFilterStr

The string resource filter in JSON format contained in the URL.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according
to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

GetWithQapiAsync(String, JObject, String)

Submits a POST request for the given resourceName with the given requestBodyNode. The requestBodyNode should be a JObject.

Declaration
public async Task<EthosResponse> GetWithQapiAsync(string resourceName, JObject qapiRequestBodyNode, string version = "")
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

JObject qapiRequestBodyNode

The body of the request to POST for the given resource as a JsonNode.

System.String version

The full version header value of the resource used for this POST request.

Returns
Type Description
Task<EthosResponse>

An EthosResponse containing the instance of the resource that was added by this POST operation.

GetWithQapiAsync(String, String, String)

Submits a POST request for the given resourceName with the given qapiRequestBody. The qapiRequestBody should be a string in JSON format.

Declaration
public async Task<EthosResponse> GetWithQapiAsync(string resourceName, string qapiRequestBody, string version = "")
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

System.String qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The full version header value of the resource used for this POST request.

Returns
Type Description
Task<EthosResponse>

An EthosResponse containing the instance of the resource that was added by this POST operation.

GetWithQapiAsync<T>(String, T, String)

Submits a POST request for the given resourceName with the given qapiRequestBody. The qapiRequestBody should be a T type class.

Declaration
public async Task<EthosResponse> GetWithQapiAsync<T>(string resourceName, T qapiRequestBody, string version = "")
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to add an instance of.

T qapiRequestBody

The body of the request to POST for the given resource.

System.String version

The full version header value of the resource used for this POST request.

Returns
Type Description
Task<EthosResponse>

An EthosResponse containing the instance of the resource that was added by this POST operation.

Type Parameters
Name Description
T

Request type.

GetWithSimpleCriteriaValuesAsync(String, String, String, String)

Convenience method to submit a GET request with a single set of criteria filter. This is intended only to be used for a single set of criteria filter, e.g:

?criteria={"names":[{"firstName":"John"}]}
, where names is the criteriaSetName, firstName is the criteriaKey, and John is the criteriaValue. Requests requiring a more complex criteria filter should first build the Criteria with the necessary criteria, and then call

getWithCriteriaFilterAsync(resourceName, criteriaFilter)
.

The parameters criteriaSetName, criteriaKey, and criteriaValue should only specify the values within quotes of the JSON filter syntax. No JSON syntax (square or angeled braces etc.) should be contained within those parameter values.

Uses the default version of the resource.

Declaration
public async Task<EthosResponse> GetWithSimpleCriteriaValuesAsync(string resourceName, string criteriaSetName, string criteriaKey, string criteriaValue)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String criteriaSetName

The name of the criteria set that the given criteriaKey and criteriaValue are associated with, e.g: "names":[{"firstName":"John"}]}, where names is the criteriaSetName associated to the criteriaKey (firstName) and criteriaValue (John).

System.String criteriaKey

The JSON label key for the criteria.

System.String criteriaValue

The value associated with the criteriaKey.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetWithSimpleCriteriaValuesAsync(String, String, String, String, String)

Convenience method to submit a GET request with a single set of criteria filter. This is intended only to be used for a single set of criteria filter, e.g:

?criteria={"names":[{"firstName":"John"}]}
, where names is the criteriaSetName, firstName is the criteriaKey, and John is the criteriaValue. Requests requiring a more complex criteria filter should first build the Criteria with the necessary criteria, and then call

getWithCriteriaFilterAsync(resourceName, version, criteriaFilter)
.

The parameters criteriaSetName, criteriaKey, and criteriaValue should only specify the values within quotes of the JSON filter syntax. No JSON syntax (square or angeled braces, etc) should be contained within those parameter values.

Declaration
public async Task<EthosResponse> GetWithSimpleCriteriaValuesAsync(string resourceName, string version, string criteriaSetName, string criteriaKey, string criteriaValue)
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

System.String criteriaSetName

The name of the criteria set that the given criteriaKey and criteriaValue are associated with, e.g: "names":[{"firstName":"John"}]}, where names is the criteriaSetName associated to the criteriaKey (firstName) and criteriaValue (John).

System.String criteriaKey

The JSON label key for the criteria.

System.String criteriaValue

The value associated with the criteriaKey.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

GetWithSimpleCriteriaValuesAsync<T>(String, String, String, String, String)

Convenience method to submit a GET request with a single set of criteria filter. This is intended only to be used for a single set of criteria filter, e.g:

?criteria={"names":[{"firstName":"John"}]}
, where names is the criteriaSetName, firstName is the criteriaKey, and John is the criteriaValue. Requests requiring a more complex criteria filter should first build the Criteria with the necessary criteria, and then call

getWithCriteriaFilterAsync(resourceName, version, criteriaFilter)
.

The parameters criteriaSetName, criteriaKey, and criteriaValue should only specify the values within quotes of the JSON filter syntax. No JSON syntax (square or angeled braces, etc) should be contained within those parameter values.

Declaration
public async Task<EthosResponse> GetWithSimpleCriteriaValuesAsync<T>(string resourceName, string criteriaSetName, string criteriaKey, string criteriaValue, string version = "")
    where T : class
Parameters
Type Name Description
System.String resourceName

The name of the resource to get data for.

System.String criteriaSetName

The name of the criteria set that the given criteriaKey and criteriaValue are associated with, e.g: "names":[{"firstName":"John"}]}, where names is the criteriaSetName associated to the criteriaKey (firstName) and criteriaValue (John).

System.String criteriaKey

The JSON label key for the criteria.

System.String criteriaValue

The value associated with the criteriaKey.

System.String version

The desired resource version header to use, as provided in the HTTP Accept Header of the request.

Returns
Type Description
Task<EthosResponse>

An

EthosResponse
containing an initial page (EthosResponse content) of resource data according to the requested version and filter of the resource.

Type Parameters
Name Description
T

Type to be included in the EthosResponse returned specified by caller.

PrepareForPagingAsync(Pager)

Intended to be used internally within the SDK.

Overrides the
prepareForPaging()
method in the EthosProxyClient super class.

Uses the given pager object to prepare for paging operations. The pager object is used to contain various fields required for paging. If the given pager is null, returns the same pager. Sets default values for the version and offset within the pager as needed and makes an initial resource call using the provided pager filter to get metadata about the resource used for paging. Also sets the page size and the total count within the pager, and encodes the filter within the pager.

Declaration
protected async Task<Pager> PrepareForPagingAsync(Pager pager)
Parameters
Type Name Description
Pager pager

The Pager object used holding the required fields for paging.

Returns
Type Description
Task<Pager>

The same pager object with the version and offset validated, the page size and total count set, and the filter encoded.

PreparePagerForPageSize(Pager)

Intended to be used internally by the SDK.

If the page size specified in the pager is <= DEFAULT_PAGE_SIZE, then this method prepares the pager object for the page size required for paging calculations. The page size is derived from the response body length after making an initial request using filters (in this case). If the response is null, the DEFAULT_MAX_PAGE_SIZE is used. If the response body is null, the x-max-page-size header is used.

If the page size specified in the pager is > DEFAULT_PAGE_SIZE, this method does nothing and just returns the given pager.

Declaration
protected Pager PreparePagerForPageSize(Pager pager)
Parameters
Type Name Description
Pager pager

The pager object used to contain the page size for paging operations.

Returns
Type Description
Pager

The pager object containing the page size.

PreparePagerForTotalCountAsync(Pager)

Intended to be used internally by the SDK.

Prepares the pager object for the total count required for paging calculations. The total count is derived from the response x-total-count header after making an initial request using filters

(in this case).
Declaration
protected async Task<Pager> PreparePagerForTotalCountAsync(Pager pager)
Parameters
Type Name Description
Pager pager

The Pager object used holding the required fields for paging.

Returns
Type Description
Task<Pager>

The pager object containing the total count. If neither a criteria filter, a named query nor a filter map is specified in the pager, then the total count will be 0.

In This Article
Back to top Generated by DocFX