public class GetLeagueGamesPublicRequest : Request,
ITokenRequest| ByeWeeks | Adds a filter to the returned list. Will include games that are ByeWeeks. If .GamesNotSet, .VirtualLeagueGames, .LocalLeagueGames, .ByeWeeks, .ForcedByeWeeks, and .CancelledGames are all false, then the default set of GamesNotSet, VirtualLeagueGames, and LocalLeagueGames will be returned. |
| CancelledGames | Adds a filter to the returned list. Will include games that are Cancelled. If .GamesNotSet, .VirtualLeagueGames, .LocalLeagueGames, .ByeWeeks, .ForcedByeWeeks, and .CancelledGames are all false, then the default set of GamesNotSet, VirtualLeagueGames, and LocalLeagueGames will be returned. |
| Conference | Adds a filter to the returned list of league games. Only games that involved one or both teams in the specified Conference are returned. Gheck GetLeagueDetail for a list of valid Conferences within this league. |
| Credentials | (Inherited from Request) |
| Division | Adds a filter to the returned list of league games. Only games that involved one or both teams in the specified Division are returned. Check GetLeagueDetail for a list of valid Divisions within this league. |
| EndDate | Adds a filter to returned list of league games. Only games that were competed partially or in whole before EndDate will be returned. The default value is to search all dates. |
| ForcedByeWeeks | Adds a filter to the returned list. Will include games that are Forced Bye Weeks. If .GamesNotSet, .VirtualLeagueGames, .LocalLeagueGames, .ByeWeeks, .ForcedByeWeeks, and .CancelledGames are all false, then the default set of GamesNotSet, VirtualLeagueGames, and LocalLeagueGames will be returned. |
| Fragment |
Returns the fragment portion of a Rest API call. Note: Not commonly used.
(Inherited from Request) |
| GameId | Returns only the League Game specified by GameId. |
| GamesNotSet | Adds a filter to the returned list. Will include games that have not yet been set to Virtual, Local, or Cancelled. If .GamesNotSet, .VirtualLeagueGames, .LocalLeagueGames, .ByeWeeks, .ForcedByeWeeks, and .CancelledGames are all false, then the default set of GamesNotSet, VirtualLeagueGames, and LocalLeagueGames will be returned. |
| 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.
(Inherited from Request) |
| HttpMethod | (Inherited from Request) |
| IgnoreFileSystemCache | (Inherited from Request) |
| 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.
(Inherited from Request) |
| LeagueId | |
| Limit | The requested number of items to return. Usually a value between 1 and 50. The default is usually 50. the API does not have to adhere to this requested limit. |
| LocalLeagueGames | Adds a filter to the returned list. Will include games that have been set Local. If .GamesNotSet, .VirtualLeagueGames, .LocalLeagueGames, .ByeWeeks, .ForcedByeWeeks, and .CancelledGames are all false, then the default set of GamesNotSet, VirtualLeagueGames, and LocalLeagueGames will be returned. |
| OperationId |
An unique string used to identify an operation.
Should be the same as the operation id listed in the Swagger documentation.
(Inherited from Request) |
| PostParameters |
Only applicable to non httpMethod.GET calls. This is the body of the request.
(Inherited from 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.
(Overrides RequestQueryParameters) |
| QueryString |
Returns a string representing the query string that may be used in the Rest API Call
(Inherited from Request) |
| 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.
(Overrides RequestRelativePath) |
| RequiresCredentials |
Indicates if this request requires user credentials. Automatically set to True when the Request constructor using UserAuthentication is used.
(Inherited from Request) |
| StartDate | Adds a filter to returned list of league games. Only games that were competed partially or in whole after StartDate will be returned. The default value is to search all dates. |
| SubDomain |
The REST API subdomain used in this request.
Automatically set to AUTHAPI when using the Request constructor using UserAuthentication. Set to API otherwise.
(Inherited from Request) |
| TeamId | Adds a filter to the returned list of league games. Only games that involved the team with the specified TeamId are returned. Check GetLeagueTeams for a list of valid teams and team ids. |
| Timeout |
Timeout, in seconds, on the http client when making requests.
Default is 15s.
(Inherited from Request) |
| Token | Token is used in a request when there is more data to return. With this pattern, the initial response will contain a value for NextToken. That value is used in the next request to return the next set of data. When making the request, a Token value of null or empty string means to return the first set of data. |
| VirtualLeagueGames | Adds a filter to the returned list. Will include games that have been set to Virtual. If .GamesNotSet, .VirtualLeagueGames, .LocalLeagueGames, .ByeWeeks, .ForcedByeWeeks, and .CancelledGames are all false, then the default set of GamesNotSet, VirtualLeagueGames, and LocalLeagueGames will be returned. |
| Copy |
Creates a new instance of a Request Object, with all the same parameters
(Overrides RequestCopy) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves 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.
(Inherited from Request) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | (Inherited from Request) |