Skip to main content

Endpoint Descriptions

All endpoints are described in the API endpoint documentation, however for some there may be some context missing and this section will explain some of the endpoints in more detail.

The Search endpoint that is available for some types such as Tyres, IssueListIssues and AssemblyIterations allows for searching of subsets of items in the database in the same way as the tyre inventory in the client software. This is a GET request with a body. As shown in the API endpoint documentation, the body object should contain a property associatedModelSearchMode. Depending on the value of this property the returned items will belong to either the whole account, a provided championship, event, car or event/car. This property is an integer with the corresponding values:

  • 0 = Account
  • 1 = Championship
  • 2 = Event
  • 3 = Car
  • 4 = Event/Car

Depending on the value provided for associatedModelSearchMode, the appropriate ID properties should be present.

TimingIntegration​

The TimingIntegration endpoints are used by the HH Timing Integration (DMI) and are designed to provide a simpler interface to update runs, laps and sectors/speed traps based on an index rather than an ID. As shown in the API endpoint documentation, all request body objects should contain the following IDs:

  • accountId
  • championshipId
  • eventId
  • sessionId
  • carId

Each body can contain an array of objects under properties that make it possible to update parameters on the run/lap/sector. These objects follow the same convention as parameter updates on the standard PUT/POST endpoints as described above.

The other parameters for various endpoints are:

  • driverId - if the driver ID is provided then the driver of the run will be updated
  • runIndex - the 0-based index of the run to be updated (i.e. for run 1, runIndex = 0)
  • stintLapNumber - the 1-based stint lap number for the lap to be updated (i.e. for the out lap of the stint, stintLapNumber = 0)
  • sectorId - when updating a sector the ID of the sector must be provided. This corresponds to the ID of the TrackSectorDefinition in the TrackConfiguration used for the current session
  • speedTrapId - when updating a speed trap the ID of the sector must be provided. This corresponds to the ID of the TrackSpeedTrapDefinition in the TrackConfiguration used for the current session
  • pitIn/OutTime - the time of day for the pit in/out. This is a date string in the extended ISO-8601 format.
  • pitIn/OutSessionTime - the session time for the pit in/out. This is a value in seconds since the start of the session.
  • shouldCreateNextRun - if this is provided as true on a pit in, then a new run will be created automatically