Aydsko iRacing Data API
Show / Hide Table of Contents

Class OfficialSearchParameters

Parameters for a hosted or league session search.

Inheritance
object
SearchParameters
OfficialSearchParameters
Inherited Members
SearchParameters.StartRangeBegin
SearchParameters.StartRangeEnd
SearchParameters.FinishRangeBegin
SearchParameters.FinishRangeEnd
SearchParameters.ParticipantCustomerId
SearchParameters.TeamId
SearchParameters.CategoryIds
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Aydsko.iRacingData.Searches
Assembly: Aydsko.iRacingData.dll
Syntax
public class OfficialSearchParameters : SearchParameters
Remarks

Valid searches require at least one of:

  • SeasonYear and SeasonQuarter
  • StartRangeBegin
  • FinishRangeBegin

Properties

EventTypes

Types of events to search for.

Declaration
[JsonPropertyName("event_types")]
public int[]? EventTypes { get; set; }
Property Value
Type Description
int[]
Remarks

Defaults to all.

See Also
EventType

OfficialOnly

Search only for sessions earning championship points.

Declaration
[JsonPropertyName("official_only")]
public bool OfficialOnly { get; set; }
Property Value
Type Description
bool
Remarks

Set to true to return sessions which are "official" only, to return all sessions (default).

RaceWeekIndex

The race week index to search for.

Declaration
[JsonPropertyName("race_week_num")]
public int? RaceWeekIndex { get; set; }
Property Value
Type Description
int?
Remarks

The iRacing Data API works with zero-based race weeks (i.e. first week is "0"), most people will use one-based overload (i.e. first week is "1") RaceWeekNumber.

RaceWeekNumber

The number of the race week within the season to search for.

Declaration
[JsonIgnore]
public int? RaceWeekNumber { get; set; }
Property Value
Type Description
int?
Remarks

Converted to and from RaceWeekIndex.

SeasonQuarter

The quarter part of the season identifier.

Declaration
[JsonPropertyName("season_quarter")]
public int? SeasonQuarter { get; set; }
Property Value
Type Description
int?
Remarks

Required when using SeasonYear.

SeasonYear

The year part of the season identifier.

Declaration
[JsonPropertyName("season_year")]
public int? SeasonYear { get; set; }
Property Value
Type Description
int?
Remarks

Required when using SeasonQuarter.

SeriesId

The Series identifier to search for.

Declaration
[JsonPropertyName("series_id")]
public int? SeriesId { get; set; }
Property Value
Type Description
int?
In this article
Back to top Generated by DocFX