Class EthosIntegrationUrls
Utility class used for building Ethos Integration URLs with various criteria.
Inheritance
Namespace: Ellucian.Ethos.Integration
Assembly: Ellucian.Ethos.Integration.dll
Syntax
public static class EthosIntegrationUrls : object
Fields
MAIN_BASE_URL
The main domain for Ethos Integration.
Declaration
const string MAIN_BASE_URL = null
Field Value
Type | Description |
---|---|
System.String |
RegionUrlPostFix
A Dictionary<SupportedRegions,string> of supported regions where each region is assigned the appropriate country code top-level domain and/or second-level domain. Supported regions include:
- US: .com
- CANADA: .ca
- EUROPE: .ie
- AUSTRALIA: .com.au
Declaration
static readonly Dictionary<dynamic, string> RegionUrlPostFix
Field Value
Type | Description |
---|---|
Dictionary<System.Object, System.String> |
Methods
AddPaging(String, Int32, Int32)
Adds paging filter criteria to the given URL string.
Declaration
static string AddPaging(string urlStr, int offset, int pageSize)
Parameters
Type | Name | Description |
---|---|---|
System.String | urlStr | The URL string to add paging criteria to. |
System.Int32 | offset | The offset param to page from. |
System.Int32 | pageSize | The limit param to page with. |
Returns
Type | Description |
---|---|
System.String | A URL string containing the offset and limit params for paging. |
Api(SupportedRegions, String, String)
The base URL for getting Api result(s) in Ethos Integration.
Declaration
public static string Api(SupportedRegions region, string resource, string id = "")
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | A supported region. |
System.String | resource | The Ethos resource the URL should contain. |
System.String | id | The (optional) ID for the given resource to build URLs for "get by ID" requests. |
Returns
Type | Description |
---|---|
System.String | A string value containing the URL to use for interacting with Ethos Integration Proxy APIs. |
ApiFilter(SupportedRegions, String, String)
Builds a URL for interacting with the proxy APIs through Ethos Integration supporting filters.
Declaration
public static string ApiFilter(SupportedRegions region, string resource, string filter)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | A supported region. |
System.String | resource | The Ethos resource the URL should contain. |
System.String | filter | The resource filter the URL should contain. |
Returns
Type | Description |
---|---|
System.String | A string value containing the URL to use for interacting with Ethos Integration Proxy APIs, supporting filters. |
ApiFilterPaging(SupportedRegions, String, String, Int32, Int32)
Builds a URL for interacting with the proxy APIs through Ethos Integration supporting paging with filters.
Declaration
public static string ApiFilterPaging(SupportedRegions region, string resource, string filter, int offset, int pageSize)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | A supported region. |
System.String | resource | The Ethos resource the URL should contain. |
System.String | filter | The resource filter the URL should contain. |
System.Int32 | offset | The row index from which to begin paging for data for the given resource. |
System.Int32 | pageSize | The number of rows each response can contain. |
Returns
Type | Description |
---|---|
System.String | A string value containing the URL to use for interacting with Ethos Integration Proxy APIs, supporting filters. |
ApiPaging(SupportedRegions, String, Int32, Int32)
Builds a URL for interacting with the Proxy APIs through Ethos Integration, in support of paging.
Declaration
public static string ApiPaging(SupportedRegions region, string resource, int offset, int pageSize)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | The appropriate supported region to build the URL with. |
System.String | resource | The Ethos resource the URL should contain. |
System.Int32 | offset | The row index from which to begin paging for data for the given resource. |
System.Int32 | pageSize | The number of rows each response can contain. |
Returns
Type | Description |
---|---|
System.String | A string value containing the URL to use for interacting with Ethos Integration Proxy APIs, in support of paging. |
AppConfig(SupportedRegions)
The URL for getting an application's configuration in Ethos Integration.
Declaration
public static string AppConfig(SupportedRegions region)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | A supported region. |
Returns
Type | Description |
---|---|
System.String | The region specific /appconfig URL |
Auth(SupportedRegions)
Builds an Ethos Integration URL supporting the Token API.
Declaration
public static string Auth(SupportedRegions region)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | The appropriate supported region to build the URL with. |
Returns
Type | Description |
---|---|
System.String | A string value containing the URL to use for interacting with Ethos Integration Token API. |
AvailableResources(SupportedRegions)
The URL for getting information about all the available resources in your tenant in Ethos Integration.
Declaration
public static string AvailableResources(SupportedRegions region)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | A supported region. |
Returns
Type | Description |
---|---|
System.String | The region specific /available-resources URL |
BaseUrl(SupportedRegions)
The URL for getting authentication tokens in Ethos Integration.
Declaration
public static string BaseUrl(SupportedRegions region)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | A supported region. |
Returns
Type | Description |
---|---|
System.String |
BuildUrl(SupportedRegions, String)
Builds the URL with the mainBaseUrl, the supported region, and the correct path.
Declaration
static string BuildUrl(SupportedRegions region, string urlEnd)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | The appropriate supported region to build the URL with. |
System.String | urlEnd | The correct path for the type of API the URL will be used with (/api for Proxy API URL, Auth(SupportedRegions) for Token API URL, etc.). |
Returns
Type | Description |
---|---|
System.String |
Consume(SupportedRegions, Nullable<Int64>, Nullable<Int32>)
Builds an Ethos Integration URL supporting the consume API.
Declaration
public static string Consume(SupportedRegions region, long? lastProcessedID, int? limit)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | The appropriate supported region to build the URL with. |
System.Nullable<System.Int64> | lastProcessedID | A value to use for the 'lastProcessedID' query parameter. Any value of zero or greater will be added to the URL as a query parameter. If the value is less than zero, it will not be added to the URL. |
System.Nullable<System.Int32> | limit | A value to use for the 'limit' query parameter. Any value greater than zero will be added to the URL as a query parameter. If the value is zero or less, it will not be added to the URL. |
Returns
Type | Description |
---|---|
System.String | The URL to use for calling the Ethos Integration consume endpoint. |
Errors(SupportedRegions)
Builds an Ethos Integration URL supporting the Errors API.
Declaration
public static string Errors(SupportedRegions region)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | The appropriate supported region to build the URL with. |
Returns
Type | Description |
---|---|
System.String | A string value containing the URL to use for interacting with Ethos Integration Errors APIs. |
ErrorsPaging(SupportedRegions, Int32, Int32)
Builds a URL for interacting with the Errors API through Ethos Integration, in support of paging.
Declaration
public static string ErrorsPaging(SupportedRegions region, int offset, int pageSize)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | The appropriate supported region to build the URL with. |
System.Int32 | offset | The row index from which to begin paging for errors. |
System.Int32 | pageSize | The number of errors (limit) each response can contain. |
Returns
Type | Description |
---|---|
System.String | A string value containing the URL to use for interacting with EthosIntegration Errors API, in support of paging. |
Qapi(SupportedRegions, String)
The base URL for getting QAPI result(s) in Ethos Integration.
Declaration
public static string Qapi(SupportedRegions region, string resource)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | A supported region. |
System.String | resource | The Ethos resource the URL should contain. |
Returns
Type | Description |
---|---|
System.String | A string value containing the URL to use for interacting with Ethos Integration Proxy APIs. |
QapiPaging(SupportedRegions, String, Int32, Int32)
Builds a URL for interacting with the proxy APIs through Ethos Integration supporting paging for QAPI POST requests
Declaration
public static string QapiPaging(SupportedRegions region, string resource, int offset, int pageSize)
Parameters
Type | Name | Description |
---|---|---|
SupportedRegions | region | A supported region. |
System.String | resource | The Ethos resource the URL should contain. |
System.Int32 | offset | The row index from which to begin paging for data for the given resource. |
System.Int32 | pageSize | The number of rows each response can contain. |
Returns
Type | Description |
---|---|
System.String | A string value containing the URL to use for interacting with Ethos Integration Proxy APIs. |