public class GetScoreHistoryAuthenticatedRequest : GetScoreHistoryAbstractRequest| Credentials | (Inherited from Request) |
| EndDate |
The end date of the range of dates to return.
The default value is Today.
(Inherited from GetScoreHistoryAbstractRequest) |
| EventStyleDef |
Gets or Sets the SetName of the Event Style for the Score History request.
On Get, a returned value of null, means the EventStyle has not been set yet.
On Set, StageStyles must be an empty list.
Setting both StageStyles and EventStyle is vorbotten.
Setting neither will return all EventStyles for the athletes in the UserIds list.
(Inherited from GetScoreHistoryAbstractRequest) |
| Format |
Gets or Sets the time span format to return data in. Default Value is Day.
(Inherited from GetScoreHistoryAbstractRequest) |
| Fragment |
Returns the fragment portion of a Rest API call. Note: Not commonly used.
(Inherited from Request) |
| 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) |
| IncludeRelated |
Gets or Sets a boolean indicating if related scores should be included in the returned calculation.
Default value is true.
(Inherited from GetScoreHistoryAbstractRequest) |
| 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.
(Inherited from GetScoreHistoryAbstractRequest) |
| 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.
(Inherited from GetScoreHistoryAbstractRequest) |
| 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) |
| StageStyleDefs |
Gets or Sets the list of SetNames of the Stage Styles for the Score History request.
On Get, an empty list returned means the StageStyles has not been set yet.
On Set, EventStyle must be null.
Setting both StageStyles and EventStyle is vorbotten.
Setting neither will return all EventStyles for the athletes in the UserIds list.
(Inherited from GetScoreHistoryAbstractRequest) |
| StartDate |
The start date of the range of dates to return.
The default value is 7 days prior to Today.
(Inherited from GetScoreHistoryAbstractRequest) |
| 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) |
| 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.
(Inherited from GetScoreHistoryAbstractRequest) |
| UserIds |
Gets or Sets the list of User IDs to retreive their Score History.
On a call .WithAuthentication the UserId is the authenticated caller is automatically included, this value does not have to be included in the list of UserIds.
On a call without .WithAuthentication, at least one UserID on UserIds is required.
User Ids are GUID formatted.
(Inherited from GetScoreHistoryAbstractRequest) |
| 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) |