For Babelfish Release 1.11.1.3

Request Class

Abstract base class for all Request Objects. A concret implementation of a Request class should coorespond to exactly one REST API method call.

Definition

Namespace: Scopos.BabelFish.Requests
Assembly: BabelFish (in BabelFish.dll) Version: 1.11.1.4+b1da393815f6638555a663d9a94167ecabea5695
C#
public abstract class Request
Inheritance
Object    Request
Derived
More

Constructors

Properties

Credentials 
Fragment Returns the fragment portion of a Rest API call. Note: Not commonly used.
HeaderKeyValuePairs Key / Value pairs of data that should be included in the request header. x-api-key is not generally included in this list, and instead is specified in the APIClient.
HttpMethod 
IgnoreFileSystemCache 
IgnoreInMemoryCache Indicates if the local response cache should be ignored and always make the request to the Rest API. The default value is false, meaning to use the local cache (if avaliable and permitted by the Rest API client). The option to ignore local cache can either be set at the API Client level, or on a per request level. Cached responses are only valid for HttpMethod GET calls.
OperationId An unique string used to identify an operation. Should be the same as the operation id listed in the Swagger documentation.
PostParameters Only applicable to non httpMethod.GET calls. This is the body of the request.
QueryParameters Returns a dictionary of name value pairs. Where the keys in the dictionary are the names And the value is a list of parameter values. The values are unescaped.
QueryString Returns a string representing the query string that may be used in the Rest API Call
RelativePath The relative path for this API Request call. For example, if the complete REST API call is https://api.orionscoringsystem.com/match/1.1.20022012248563984.0, then this property would return "/match/1.1.20022012248563984.0". Note, return value includes the front slash.
RequiresCredentials Indicates if this request requires user credentials. Automatically set to True when the Request constructor using UserAuthentication is used.
SubDomain The REST API subdomain used in this request. Automatically set to AUTHAPI when using the Request constructor using UserAuthentication. Set to API otherwise.
Timeout Timeout, in seconds, on the http client when making requests. Default is 15s.

Methods

Copy Creates a new instance of a Request Object, with all the same parameters
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetRequestCacheKey Concrete implementationst that want to cache their requests, must implement a unique string to be used as the request key.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToString
(Overrides ObjectToString)

See Also