public class MatchSearchAuthenticatedRequest : MatchSearchAbstractRequest| MatchSearchAuthenticatedRequest | Authenticated constructor. User is encouraged (really you need to do this) to set the Request Properties at time of construction. |
| Credentials | (Inherited from Request) |
| Distance |
Distance in miles to search.
The default is 100 miles.
(Inherited from MatchSearchAbstractRequest) |
| EndDate |
The end date of the match dates to search.
The default value is the last day of the current month.
(Inherited from MatchSearchAbstractRequest) |
| 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) |
| Latitude |
The Latitude of an area to search.
If > default of 0, Longitude must also be > 0.
(Inherited from MatchSearchAbstractRequest) |
| Limit |
The maximum number of search results to return.
(Inherited from MatchSearchAbstractRequest) |
| Longitude |
The Logitude of an area to search.
If > default of 0, Latitude must also be > 0.
(Inherited from MatchSearchAbstractRequest) |
| 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 | (Inherited from MatchSearchAbstractRequest) |
| 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) |
| ShootingStyle |
The shooting style to search or unassigned for all.
The default value is Air Rifle.
(Inherited from MatchSearchAbstractRequest) |
| StartDate |
The start date of the match dates to search.
The default value is the first day of the current month.
(Inherited from MatchSearchAbstractRequest) |
| 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 MatchSearchAbstractRequest) |
| 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) |