API docs by Redocly

Race Roster API (1.0.0)

Download OpenAPI specification:

License: Apache-2.0

I. General information

1. Authentication

Race Roster API method calls are designed exclusively for private data access. API uses OAuth2 for authentication. All API requests must be authenticated with a valid OAuth token.

The access token must be provided in the authorization header: Authorization: Bearer eyJ0eXAiOiJKV3QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJFcGIyWjUyVVFaNWZjbWdKV3NwdkROVktaeEc2NGhOQTNzRWJuc2tZIiwianRpIjoiYjk2NTc1YzA3ZDczMDk0ZDQ3OGJlYjhlNTRhNjQ2NmFkMjc3YWY5NGVjNGRjZGRhNDBhNGMxMGUxNzk3OGIzZmUyZWJjOTE2ZjM4OTI5MTciLCJpYXQiOjE3NTMyMDQxNzAuNzc2ODk5LCJuYmYiOjE3NTMyMDQxNzAuNzc2OTAyLCJleHAiOjE3NTMyOTA1NzAuNzMzOTQ1LCJzdWIiOiI1Nzc4OTMyIiwic2NvcGVzIjpbInRpbWVyIl19.VeOzMUyckjzL4dUvLI973mG63x8Db94N_dboDOt8bae-k-OP5jneMZLhLkikCdqmc5naD_TJFnyp8CFjxt5knww_VJRSn2Xzm2ESmN1-vKKB50P9AVUQ2VQN8IyVgp_OSanF4McQS7ZVIsFGwRRhtT6wsiJdIsgUHqkiFwvVmPtbHAm1WwaC8y5Xf2Yn9KlAyP8WSnB23UBXRSmTBbDnvXcbMa2cniSaJKJdpoeJVLUjFsxv-WDhdvk8pnZZ04CoZeiPIWZK2BjkRCYagl9uhb7-ew0Vtdds6QhKri_grBe61xyPIHdO64RY-2p5s2LUJ0BCCZc4-E6hRPCYBNHwPw

For OAuth2 URLs see

2. Response status codes

Code Description
200 OK
201 Created
204 Resource was deleted successfully
400 Bad Request. The data in your request failed validation
401 Unauthorized
403 Forbidden
404 Not Found
405 Method not allowed
500 Server Error
501 Not implemented

3. HTTP Verbs

HTTP Verb Description
GET Used for retrieving resources.
POST Used for creating resources.
PUT Used for updating resource sets.
PATCH Used for updating set fields (i.e., making result active / not active)
DELETE Used for deleting resources.

4. Resources

1. Base URL

https://raceroster.com/api/v1

2. Parameters

Many API methods take optional parameters. For GET requests, any parameters not specified as a segment in the path can be passed as an HTTP query string parameter:

?firstKey=firstValue&options=comma,Delimited,Field,Options&secondKey=SecondValue

3. Response formats

Race Roster's API supports responses in JSON format.

  • Headers Accept: application/json

4. Objects and data types

1. Boolean

Standard boolean.

true|false

2. Integer

Standard integer.

4

3. String

Standard string

"Race Roster API"

4. Datetime

A date in ISO8601 date format. Represented as a string.

When passing date with + character remember that plus character is reserved character (RFC 2396) and it should be url encoded.

"2014-02-12T15:19:21+00:00"

5. Gender

A gender code based loosely on the ISO 5218 gender class, with the addition of a "Co-Ed" or "Mixed" gender for teams comprised of multiple genders. Represented as an integer.

0 = Prefer not to disclose,
1 = Male,
2 = Female,
8 = Co-Ed,
9 = Non-binary.

II. API Resources

Authorize and Access

This section groups Race Roster authorize and access resources.

Authorize & obtain access token

To authenticate users via the API, the Client application sends a POST request with form URL-Encoded body parameters to the authorization server.

Timers can obtain the client_id and client_secret by creating a new OAuth client from the API settings page: https://raceroster.com/dashboard/account/api-settings

The authorization server will respond with a JSON object that is contained in a top level "data" array. The JSON object contains the following properties:

  • access_token (string) - a JWT signed with the authorization server's private key

  • token_type (string) - with the value Bearer

  • expires_in (int) - with an integer representing the TTL of the access token in seconds. The value is set to 86400 (24 hours).

  • refresh_token (string) - This will only be returned if the provided grant_type was set to 'access_token'. This property is an encrypted payload that can be used to refresh the access token when it expires. This token will expire in 25 hours.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Request Body schema:
Schema not provided

Responses

Request samples

Content type
grant_type=access_token&client_id=ILAH0GS9OccIjGAuavpZkJIGO6973pGtjWzESYRm&client_secret=Aho2z875Zxixl9n3WEU3Qj2ixiWepp0yX4bmhQIZ&username=example%40gmail.com&password=Password123

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Refresh access token

Access tokens eventually expire. Refresh tokens enable the client to refresh the access token without asking the user for their username and password again.

Client application sends a POST request with form URL-Encoded body parameters to the authorization server.

Authorization server will grant a new access token for the user and respond with a JSON object containing the following properties:

  • access_token (string) - a JWT signed with the authorization server's private key

  • token_type (string) - with the value Bearer

  • expires_in (int) - with an integer representing the TTL of the access token in seconds. The value is set to 86400 (24 hours).

  • refresh_token (string) - an encrypted payload that can be used to refresh the access token when it expires. This token will expire in 25 hours.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Request Body schema:
Schema not provided

Responses

Request samples

Content type
grant_type=refresh_token&client_id=ILAH0GS9OccIjGAuavpZkJIGO6973pGtjWzESYRm&client_secret=Aho2z875Zxixl9n3WEU3Qj2ixiWepp0yX4bmhQIZ&refresh_token=8hoepZbmVtZCNLBJCONt56iCiBBhW5Wa7zbjg3un

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Countries and provinces

This section groups Race Roster countries and provinces resources.

Countries and provinces

List countries and regions.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Modify countries and/or provinces

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Add countries and/or provinces

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete countries and/or provinces

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Events

This section groups Race Roster event resources.

Retrieve list of Events

NOTE: This method will return only events with LIVE or PRIVATE status and event date greater than current date.

query Parameters
offset
string
Default: "0"

Starting point for records returned per request

limit
string
Default: "25"

Number of records returned per request

sort
string
Default: "startDate"
Enum: "eventId" "name" "city" "region" "country" "startDate" "registrationOpenDate" "registrationCloseDate"

Field name used to sort returned results

order
string
Default: "desc"
Enum: "asc" "desc"

Results sorting

eventDateFrom
string
Default: "null"

Date filter used to return events with dates later than timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

eventDateTo
string
Default: "null"

Date filter used to return events with dates earlier than timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

lastModifiedDate
string
Default: "null"

Date filter used to return events with update dates greater than timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

eventIds
string
Default: "null"

Comma separated list of eventId. Filter will remove events with not matching IDs from returned results.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add event

This method will create an event.

Request Body schema: application/json
countryCode
required
string
Enum: "US" "CA" "MX" "AG" "AR" "AU" "BB" "BR" "KY" "CL" "CN" "CU" "DO" "EC" "GD" "HK" "ID" "IN" "IL" "JM" "JP" "KE" "NZ" "NI" "NO" "PH" "RU" "SG" "LC" "ZA" "TH" "TT" "TR" "GB" "BS" "CR" "NL" "AE"

The country code that the event will take place in.

currency
required
string
Enum: "CAD" "USD" "MXN" "RUB" "AUD" "EUR" "DKK" "GBP" "SEK"

The currency of the event.

name
required
string

The name of the event.

eventDate
required
string

The date of the event in ATOM or ISO 8601 format: YYYY-MM-DDTHH:MM:SS+/-HH:MM. e.g. 2024-06-25T09:00:00-0400 or 2024-06-25T09:00:00-04:00.

accessCode
string

This field is required if the event organizer email is provided. This access code will be used by the new event organizer during the event claiming process. This access code must be shared with the new event organizer in order for them to complete the event claiming process.

lineOne
string

The 1st line of the address that the event will take place in.

lineTwo
string

The 2nd line of the address that the event will take place in.

city
string

The city that the event will take place in.

postalCode
string

The ZIP/postal code that the event will take place in.

companyId
integer

The company ID of the event. If omitted then the first company that the account belongs to will be used.

eventOrganizerEmail
string

The email address of the user who will be added as an event organizer for this event. An email will be sent to this email address, which will allow the end user to claim this event and become a race organizer.

eventTypeId
integer

The event type ID of the event. If omitted then a default value of 1 will be used, which represents a Running event.

fullAddress
string

The address that the event will take place in.

status
string
Enum: "LIVE" "PRIVATE"

The status of the event. If omitted then a default value of "PRIVATE" will be used.

subdivisionCode
required
string

The sub division code that the event will take place in. Required if the country code is one of: AU, CA, TT, US. This value must be one of the following options for the given country code: AU [ ACT, NSW, NT, QLD, SA, TAS, VIC, WA ], CA [ AB, BC, MB, NB, NL, NS, ON, PE, QC, SK, NT, NU, YT ], TT [ ARI, CHA, CTT, DMN, MRC, PED, PTF, POS, PRT, SGE, SJL, SFO, SIP, TOB, TUP ], US [ AA, AE, AL, AP, APO, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY ]. If the provided country code is not one of ones mentioned above then do not include this parameter in the request.

timezone
string

The timezone of the date for the event. Generally it should match the timezone offset of the eventDate value. If the timezone provided does not match the offset in eventDate, the event date will be converted to align with the timezone provided. e.g. an eventDate: "2024-08-06T00:00:00-07:00" with timezone: "America/Vancouver" yields 2024-08-06 00:00:00, but an eventDate: "2024-08-06T00:00:00-04:00" with timezone: "America/Vancouver" yields 2024-08-05 21:00:00. If no timezone is provided then this value will be determined based on the offset given in the event date. The valid options depend on the provided country code. If the country code is CA for example, then the valid timezones would be: [ America/Dawson, America/Vancouver, America/Whitehorse, America/Cambridge_Bay, America/Creston, America/Dawson_Creek, America/Edmonton, America/Fort_Nelson, America/Inuvik, America/Yellowknife, America/Rainy_River, America/Rankin_Inlet, America/Regina, America/Resolute, America/Swift_Current, America/Winnipeg, America/Atikokan, America/Iqaluit, America/Nipigon, America/Pangnirtung, America/Thunder_Bay, America/Toronto, America/Blanc-Sablon, America/Glace_Bay, America/Goose_Bay, America/Halifax, America/Moncton, America/St_Johns ]

locale
string
Enum: "en_US" "en_CA" "fr_CA" "ja_JP" "id_ID" "ms_MY" "en_AU" "en_GB" "en_AE" "en_NZ" "es_MX" "zh_CN" "zh_HK" "th_TH" "vi_VN"

The locale of the event. If omitted then a default value of "en_US" will be used. More locales are added regularly.

Responses

Request samples

Content type
application/json
{
  • "countryCode": "CA",
  • "currency": "CAD",
  • "eventDate": "2019-11-11T15:19:21-0700",
  • "name": "2019 Race Roster 10k",
  • "accessCode": "password1234",
  • "lineOne": "186 York St",
  • "lineTwo": "",
  • "city": "London",
  • "postalCode": "N6A 1B5",
  • "companyId": 1,
  • "eventOrganizerEmail": "example@example.com",
  • "eventTypeId": 2,
  • "fullAddress": "186 York St, London, ON N6A 1B5",
  • "status": "LIVE",
  • "subdivisionCode": "ON",
  • "timezone": "America/Dawson_Creek",
  • "locale": "en_US"
}

Response samples

Content type
application/json
{}

Delete events

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Add sub-event

This method will create a sub-event.

path Parameters
eventId
required
string

Event ID

Request Body schema: application/json
name
required
string

The name of the sub-event

description
string

The description of the sub-event

minimumAge
integer

The minimum age of entry for participants to this sub-event.

maximumAge
integer

The maximum age of entry for participants to this sub-event

restrictAccess
boolean

Restrict this sub-event to participants that have access codes

calculateAgeAsOf
string
Enum: "event-date" "date-registered" "year-end" "custom"

The date used to calculate the age of the participants

customDate
string

The date of the event. This field is required if the calculateAgeAsOf field is set to "custom". Must be provided in the following format: YYYY-MM-DD

distanceId
string

The ID of the distance of the event. If provided then one of the following values must be provided: [5K => a6e22291-a6ed-11e8-8c16-0a2fd0bccf82] [10K => a6e22468-a6ed-11e8-8c16-0a2fd0bccf82] [Half marathon => a6e225a3-a6ed-11e8-8c16-0a2fd0bccf82] [1K => a6e22657-a6ed-11e8-8c16-0a2fd0bccf82] [1 Mile => a6e226e9-a6ed-11e8-8c16-0a2fd0bccf82] [Marathon => a6e22777-a6ed-11e8-8c16-0a2fd0bccf82] [8K => a6e227fa-a6ed-11e8-8c16-0a2fd0bccf82] [10 Mile => a6e22882-a6ed-11e8-8c16-0a2fd0bccf82] [50K => a6e22906-a6ed-11e8-8c16-0a2fd0bccf82] [8 Mile => a6e22986-a6ed-11e8-8c16-0a2fd0bccf82] [60K => a6e22a03-a6ed-11e8-8c16-0a2fd0bccf82] [75K => a6e22a7f-a6ed-11e8-8c16-0a2fd0bccf82] [100K => a6e22afb-a6ed-11e8-8c16-0a2fd0bccf82] [Century => a6e22b84-a6ed-11e8-8c16-0a2fd0bccf82] [Half century => a6e22c05-a6ed-11e8-8c16-0a2fd0bccf82] [Metric century => a6e22c86-a6ed-11e8-8c16-0a2fd0bccf82] [Sprint (750 m, 20 km, 5 km) => a6e22d04-a6ed-11e8-8c16-0a2fd0bccf82] [Olympic (1.5 km, 40 km, 10 km) => a6e22d83-a6ed-11e8-8c16-0a2fd0bccf82] [Half distance (1.9 km, 90 km, 21.1 km) => a6e22e00-a6ed-11e8-8c16-0a2fd0bccf82] [Long distance (3.9 km, 181 km, 42.2 km) => a6e22e7d-a6ed-11e8-8c16-0a2fd0bccf82] [1500 m => a6e22ef8-a6ed-11e8-8c16-0a2fd0bccf82] [Other distance => a6e22f75-a6ed-11e8-8c16-0a2fd0bccf82]

distanceValue
number

The distance of the sub-event. This field is required if the "other distance" ID is used as the value in the distance ID field

distanceUnit
string
Enum: "kilometers" "meters" "miles" "yards"

The unit of measurement for the distance of the sub-event. This field is required if the "other distance" ID is used as the value in the distance ID field

Responses

Request samples

Content type
application/json
{
  • "name": "2019 Race Roster 50 miler",
  • "description": "A family fun event where you can walk or run!",
  • "minimumAge": 5,
  • "maximumAge": 85,
  • "restrictAccess": true,
  • "calculateAgeAsOf": "custom",
  • "customDate": "2000-12-25",
  • "distanceId": "a6e22f75-a6ed-11e8-8c16-0a2fd0bccf82",
  • "distanceValue": 50,
  • "distanceUnit": "miles"
}

Response samples

Content type
application/json
{}

Retrieve single event

NOTE: This method will return only events with LIVE or PRIVATE status.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "eventId": "44bf76b5-7c97-11",
  • "type": "raceroster",
  • "name": "2015 Alcatraz XXXV Escape from the Rock",
  • "city": "San Francisco",
  • "region": {
    },
  • "country": {
    },
  • "startDate": "2014-02-12T15:19:21+00:00",
  • "timeZone": "America/Vancouver",
  • "registrationOpenDate": "2014-02-12T15:19:21+00:00",
  • "registrationCloseDate": "2014-02-12T15:19:21+00:00",
  • "lastModifiedDate": "2015-02-11T15:19:12+00:00",
  • "url": "https://raceroster.com/events/2015/761/2015-alcatraz-xxxv-escape-from-the-rock",
  • "organizerName": "John Doe",
  • "organizerEmail": "john@email.com",
  • "organizerPhone": "+18559695515",
  • "organizerDashboardUrl": "https://raceroster.com/dashboard/event-organizers/legacy/Home?eid=1",
  • "address": "Street 23, London, Ontario, Canada",
  • "latitude": 43.7820344,
  • "longitude": -88.4437064,
  • "locale": "en_US",
  • "description": "Lorem Ipsum description",
  • "facebook": "https://www.facebook.com/RaceRoster",
  • "twitter": "RaceRoster",
  • "branding": {},
  • "resultsUrl": "https://results.raceroster.com/results/am52payyhk52ma9r",
  • "subEvents": {
    }
}

Modify event

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 501,
  • "message": "Not implemented"
}

Delete event

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Retrieve event types

This method will return all the available event types.

Responses

Update event settings

This method will update event settings.

path Parameters
eventId
required
string

Event ID

Request Body schema: application/json
timingCrewId
integer

The ID of the timing crew

notificationMethod
required
string
Enum: "DISABLED" "USER" "TIMING_CREW"

The notification method setting

resultsPerPage
integer

The number of results per page by default

eventTimePrecision
required
string
Enum: "full_second" "tenth_of_a_second" "hundredth_of_a_second" "thousandth_of_a_second"

The event time precision setting

Responses

Request samples

Content type
application/json
{
  • "timingCrewId": 100,
  • "notificationMethod": "USER",
  • "resultsPerPage": 50,
  • "eventTimePrecision": "full_second"
}

Reporting

Event reporting. Note: Event reporting requires additional API permissions (API Financials). Note: Currency values are represented in the lowest denominator for the event's currency (ex. cents).

Event revenue

Returns financial data for an event including revenue, fees paid and currency.

path Parameters
eventId
required
string

Event ID

Responses

Event individual charities amount raised

Retrieve various properties of each individual charity for an event.

path Parameters
eventId
required
string

Event ID

Responses

Event charities total amount raised

Returns the total amount raised for all charities of an event.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Event charities participant amount raised

Returns the amount raised for each participant of an event.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{}

Event charities team amount raised

Returns the amount raised for each team of an event.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{}

Participants

This section groups Race Roster team resources.

List participants

Retrieve list of participants for given event ID. NOTE: By default method will return participants for all sub-events. NOTE: profile information visibility is enabled/disabled by Race Directors. In case profile data is not shared through API profile array will be just empty. NOTE: USAT number is provided in read only mode. It can not be updated or set when participant is updated or created.

path Parameters
eventId
required
string

Event ID

query Parameters
subEventId
string

Sub-event ID filter

modifiedAfterDateTime
string

UTC Date Time string. Date filter used to return events with dates later than timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

teamId
string

Team ID filter used to return participants that are members on a given teamId.

hasTeam
boolean

Team filter based on whether a participant is assigned to a team or not

  • When true list participants endpoint returns ONLY participants that are on teams.

  • When false list participants endpoint returns ONLY participants that are NOT on teams.

  • When filter is not included in the query string list participants endpoint returns ALL participants that are registered regardless of whether they are assigned to a team or not.

offset
string
Default: "0"

Starting point for records returned per request

limit
string
Default: "500"

Number of records returned per request

sort
string
Default: "participantId"
Enum: "participantId" "registrationDate" "age"

Field name used to sort returned results

order
string
Default: "asc"
Enum: "asc" "desc"

Results sorting

include
string
Default: "charity,promoCode,shippingDetails,inactive,teamDetails,startGroup"
Enum: "charity" "promoCode" "shippingDetails" "inactive" "teamDetails" "startGroup"

Comma separated list of field names to be included in returned results

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Create participants

Create multiple participants.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update participants

Update one or more participants and their fields at a time.

path Parameters
eventId
required
string

Event ID

Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete participants

Delete multiple participants.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Participant

Retrieve participant for given event ID and participant ID. NOTE: profile information visibility is enabled/disabled by Race Directors. In case profile data is not shared through API profile array will be just empty. The properties shippingDetails and swag..swagTransactionId were added on February 12, 2024.

path Parameters
eventId
required
string

Event ID

participantId
required
string

Participant ID

query Parameters
include
string
Default: "charity,promoCode,shippingDetails,teamDetails,startGroup"
Enum: "charity" "promoCode" "shippingDetails" "teamDetails" "startGroup"

Comma separated list of field names to be included in returned results

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete participant

Delete single participant.

path Parameters
eventId
required
string

Event ID

participantId
required
string

Participant ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Bulk opt-in

Opt-in or opt-out participant.

path Parameters
eventId
required
string

Event ID

Request Body schema: application/json
Array
type
required
string
Default: ""
Enum: "sms" "email"

Type of address that will be opted-in or opted-out

address
required
string
Default: ""

Valid phone number or valid email address. Phone number needs to be provided in E.163 format ie.: +14155552671

participantId
required
integer
Default: 0
optIn
required
boolean
Default: false

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "error": 400,
  • "message": "Bad Request. The data in your request failed validation. Request cannot be empty [code: e_5e6930aa40e81]"
}

Teams

This section groups Race Roster team resources.

List Team Types

Retrieve list of team types for given event ID.

path Parameters
eventId
required
string

Event ID

query Parameters
offset
string
Default: "0"

Starting point for records returned per request

limit
string
Default: "25"

Number of records returned per request

sort
string
Default: "teamTypeId"

Field name used to sort returned results

order
string
Default: "asc"
Enum: "asc" "desc"

Results sorting

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add team types

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update team types

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete team types

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get a single Team Type

Retrieve a single team types for given event ID.

path Parameters
eventId
required
string

Event ID

teamTypeId
required
string

Team Type ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List Teams

Retrieve list of teams for given event ID.

path Parameters
eventId
required
string

Event ID

query Parameters
offset
string
Default: "0"

Starting point for records returned per request

limit
string
Default: "500"

Number of records returned per request

sort
string
Default: "teamId"

Field name used to sort returned results

order
string
Default: "asc"
Enum: "asc" "desc"

Results sorting

include
string
Default: "``"
Value: "teamType"

Comma separated list of field names to be included in returned teams

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Add teams

path Parameters
eventId
required
string

Event ID

query Parameters
offset
string
Default: "0"

Starting point for records returned per request

limit
string
Default: "500"

Number of records returned per request

sort
string
Default: "teamId"

Field name used to sort returned results

order
string
Default: "asc"
Enum: "asc" "desc"

Results sorting

include
string
Default: "``"
Value: "teamType"

Comma separated list of field names to be included in returned teams

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update teams

path Parameters
eventId
required
string

Event ID

query Parameters
offset
string
Default: "0"

Starting point for records returned per request

limit
string
Default: "500"

Number of records returned per request

sort
string
Default: "teamId"

Field name used to sort returned results

order
string
Default: "asc"
Enum: "asc" "desc"

Results sorting

include
string
Default: "``"
Value: "teamType"

Comma separated list of field names to be included in returned teams

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete teams

path Parameters
eventId
required
string

Event ID

query Parameters
offset
string
Default: "0"

Starting point for records returned per request

limit
string
Default: "500"

Number of records returned per request

sort
string
Default: "teamId"

Field name used to sort returned results

order
string
Default: "asc"
Enum: "asc" "desc"

Results sorting

include
string
Default: "``"
Value: "teamType"

Comma separated list of field names to be included in returned teams

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Registration questions

This section groups Race Roster registration questions resources.

List multiple registration questions

Retrieve list of registration questions for given event ID.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add registration questions

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update registration questions

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete registration questions

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get a single registration question

Retrieve a single registration question for given event ID.

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Add registration question

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update registration question

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete registration question

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get question options

Retrieve registration question options.

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add question options

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update question options

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete question options

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get question option

Retrieve registration question option by ID.

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

optionId
required
string

Question option ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Add question option

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

optionId
required
string

Question option ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update question option

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

optionId
required
string

Question option ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete question option

path Parameters
eventId
required
string

Event ID

questionId
required
string

Registration question ID

optionId
required
string

Question option ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Products

This section groups Race Roster registration products (swag) resources.

List multiple products

Retrieve list of products for given event ID.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{ }

Add products

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update products

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete products

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get a single product

Retrieve a single product for given event ID.

path Parameters
eventId
required
string

Event ID

productId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{}

Add product

path Parameters
eventId
required
string

Event ID

productId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update product

path Parameters
eventId
required
string

Event ID

productId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete product

path Parameters
eventId
required
string

Event ID

productId
required
string

Registration question ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get product options

Retrieve product options.

path Parameters
eventId
required
string

Event ID

productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add product options

path Parameters
eventId
required
string

Event ID

productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update product options

path Parameters
eventId
required
string

Event ID

productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete product options

path Parameters
eventId
required
string

Event ID

productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get product option

Retrieve registration question option by ID.

path Parameters
eventId
required
string

Event ID

productId
required
string

Product ID

optionId
required
string

Product option ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Add option

path Parameters
eventId
required
string

Event ID

productId
required
string

Product ID

optionId
required
string

Product option ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update option

path Parameters
eventId
required
string

Event ID

productId
required
string

Product ID

optionId
required
string

Product option ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete option

path Parameters
eventId
required
string

Event ID

productId
required
string

Product ID

optionId
required
string

Product option ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Results

This section groups Race Roster results resources.

Get companies

This method will get all the companies for the current user.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get timing crews

This method will get all the timing crews for the given company ID. The current user must also be a member of the company.

path Parameters
companyId
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get fields map

Returns map of fields used to describe columns with results posted to Race Roster API.`.

path Parameters
companyId
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create fields map

path Parameters
companyId
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update fields map

path Parameters
companyId
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete fields map

path Parameters
companyId
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get custom columns

Returns all the map types used to describe the custom columns of results posted to Race Roster.

path Parameters
companyId
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create custom columns

path Parameters
companyId
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update custom columns

path Parameters
companyId
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete custom columns

path Parameters
companyId
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get custom column

path Parameters
companyId
required
string

Company ID

Responses

Create custom column

Creates a new custom column.

The payload accepts the following parameters:

  • label (string, required) - The label of the custom column.

  • type - (string, optional) The type of formatter for the custom column. This can be one of two values, text or link. This will default to text if omitted.

path Parameters
companyId
required
string

Company ID

Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{
  • "label": "Custom Label",
  • "type": "text"
}

Response samples

Content type
application/json
{
  • "code": 201,
  • "message": "Created"
}

Update custom column

Updates an existing custom column.

The payload accepts the following parameters:

  • label (string, optional) - The label of the custom column.

  • type - (string, optional) The type of formatter for the custom column. This can be one of two values, text or link.

path Parameters
companyId
required
string

Company ID

customColumnId
required
string

Custom column ID

Request Body schema: application/json
label
string
type
string

Responses

Request samples

Content type
application/json
{
  • "label": "Custom Label",
  • "type": "link"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "Updated"
}

Delete custom column

Deletes an existing custom column.

path Parameters
companyId
required
string

Company ID

customColumnId
required
string

Custom column ID

Responses

Get segment types

Returns segment types defined in Race Roster system. NOTE: segments that are defined as transition type have no distance or pace units. null is returned for availableDistanceUnits in such cases.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create segment types

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update segment types

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete segment types

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get results races

Returns array of available races for event.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create races

Results races are containers for your results.

To set a custom (non-standard) distance for a race, set the distanceId property with the ID of the "Other distance" (see 'Results: Get Distances'), and include the otherDistanceValue and otherDistanceUnit properties.

path Parameters
eventId
required
string

Event ID

Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Update races

Updating multiple races in one request is currently not supported. Please see Update results race instead.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete races

Deleting multiple races in one request is currently not supported. Please see Delete results race instead.

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get race

Returns single race for event and race ID.

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Results race ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create race

Please see Create results races instead.

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Results race ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update race

Note: subEventId can be set only on events that have a type of raceroster.

To set a custom (non-standard) distance for the race, set the distanceId property with the ID of the "Other distance" (see 'Results: Get Distances'), and include the otherDistanceValue and otherDistanceUnit properties.

To enable Live Predictive Tracking (LPT), a number of requirements must be met, including:

  1. For a race in cumulative segments mode, at least one non-transition segment exists
  2. For a race in interval segments mode, at least two non-transition segments of the same type exist
path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Results race ID

Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{
  • "name": "5K Walk & Run",
  • "subEventId": 909,
  • "isPublic": true,
  • "sortOrder": 115,
  • "distanceId": "a6e22291-a6ed-11e8-8c16-0a2fd0bccf82",
  • "segmentsMode": "cumulative",
  • "livePredictiveTracking": {
    }
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "Updated"
}

Delete race

Delete single results race

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Results race ID

Responses

Get race segments

Returns segments for race ID.

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Results race ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create race segments

Note that the race "segmentsMode" determines how the distance value for each segment is defined. For a segments mode of "cumulative", the distance value defines the "cumulative" distance from the start of the race to the end of the segment. In this case, the "interval" distance is calculated based from the end of the previous segment to the end of the current segment. Vice versa, for a segments mode of "interval" (default), the distance value defines the "interval" distance from the end of the previous segment to the end of the current segment.

NOTE: a transition segment (i.e. the transition from swim to bike or bike to run in a triathlon) does not have a distance! You will not be able to create a segment with a transition type and also a distance property. Transition segments do not have a "calculatePaceBy" or "calculateCumulativePaceBy" value since they have no distance.

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Results race ID

Request Body schema: application/json
Array
segmentTypeId
required
integer

(Required) The ID of the segment type for this segment.

name
required
string

(Required) The name of this segment. e.g. 5k split, or Run or Transition 1

distanceValue
number

(Required for non-transition segment type in interval segments mode) The interval distance value (interval segments mode only, non-transition segments)

distanceUnit
string

(Required for non-transition segment type in interval segments mode) The interval distance unit (interval segments mode only, non-transition segments). One of mi, km, yd, m, ft.

calculatePaceBy
string

(Optional, defaults to "min/mi") The pace units to calculate interval pace by (interval segments mode only). One of min/km, min/mi, km/hr, mi/hr, min/100 m or min/100 y. Not applicable for transition type segments. Note: can be overridden by passing units with the result segment pace value (i.e. 45 mi/hr).

cumulativeDistanceValue
number

(Required for non-transition segment type in cumulative segments mode) The cumulative distance value (cumulative segments mode only, non-transition segments)

cumulativeDistanceUnit
string

(Required for non-transition segment type in cumulative segments mode) The cumulative distance unit (cumulative segments mode only, non-transition segments). One of mi, km, yd, m, ft.

calculateCumulativePaceBy
string

(Optional, defaults to min/mi) The pace units to calculate cumulative pace by (cumulative segments mode only). One of min/km, min/mi, km/hr, mi/hr, min/100 m or min/100 y. Not applicable for transition type segments. Note: can be overridden by passing units with the result segment pace value (i.e. 45 mi/hr).

sortOrder
required
integer

(Required) A positive order by integer. If omitted, will be generated with values to retain post order

Responses

Request samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Update race segments

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Results race ID

Request Body schema: application/json
Array
segmentId
required
integer

(Required) The ID of the segment to update.

segmentTypeId
required
integer

(Required) The ID of the segment type of this segment.

name
required
string

(Required) The name of the segment.

distanceValue
number

(Required for non-transition segment type in interval segments mode) The interval distance value (interval segments mode only, non-transition segments)

distanceUnit
string

(Required for non-transition segment type in interval segments mode) The interval distance unit (interval segments mode only, non-transition segments). One of mi, km, yd, m, ft.

calculatePaceBy
string

(Optional, defaults to min/mi) The pace units to calculate interval pace by. One of min/km, min/mi, km/hr, mi/hr, min/100 m or min/100 y. Not applicable for transition type segments. Note: can be overridden by passing units with the result segment pace value (i.e. 45 mi/hr).

cumulativeDistanceValue
number

(Required for non-transition segment type in cumulative segments mode) The cumulative distance value (cumulative segments mode only, non-transition segments)

cumulativeDistanceUnit
string

(Required for non-transition segment type in cumulative segments mode) The cumulative distance unit (cumulative segments mode only, non-transition segments). One of mi, km, yd, m, ft.

calculateCumulativePaceBy
string

(Optional, defaults to min/mi) The pace units to calculate cumulative pace by. One of min/km, min/mi, km/hr, mi/hr, min/100 m or min/100 y. Not applicable for transition type segments. Note: can be overridden by passing units with the result segment pace value (i.e. 45 mi/hr).

sortOrder
required
integer

(Required) The positive order integer value.

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Delete race segments

Delete all segments for given eventId and resultsRaceId NOTE: All results must be removed from the race prior to deleting race segments.

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Results race ID

Responses

Get Distances

Returns an array of all the distances that can be assigned to a race in an event.

Note: The "Other distance" represents a custom (non-standard) distance. Use the "Other distance" ID, which remains constant, in conjunction with a custom value and unit (km, mi, m, yd, ft) to specify a custom (non-standard) distance of a race. If the race does not have a distance, use the "Not applicable" distance ID.

path Parameters
eventId
required
string

Event ID

query Parameters
type
string

Filters the array of distances so that only the distances that match the provided type are returned (e.g. running, cycling, triathlon, swimming, other).

Responses

Create Distance

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Update Distance

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Delete Distance

path Parameters
eventId
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "message": "Method not allowed"
}

Get Results

Retrieve list of posted (raw, i.e. unprocessed) results for given event and result race ID.

path Parameters
eventId
required
string

Event ID.

query Parameters
resultsRaceId
required
string

If this is provided then only the results that correspond to this result race ID will be returned.

page
required
string

The page of results that will be returned.

perPage
required
string

The number of results that will be returned per page.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Results

Upload results for given event, race and result set ID.

Note: if results already exist, this endpoint performs an "upsert" (insert/update) operation on existing results (matching bib number, participant id and/or name), and also performs a pruning operation that removes existing results not referenced in the payload.

Results payload requires 3 indices:

  • columns (array, required) - collection of arrays describing column label and fieldId mapping (see Get fields map for reference)

  • metaData - (array, required) array of additional information about results. See JSON-SCHEMA for details.

  • results (array, required) - collection of participant result information

path Parameters
eventId
required
string

Event ID.

Request Body schema: application/json
required
required
Array of objects
required
object
required
Array of resultsRaceId (integer) or (fieldsMapItems (fieldsMapItems (string) or fieldsMapItems (integer) or Array of fieldsMapItems (arrays))) or segmentDataObjects (object)[ items ]

Responses

Request samples

Content type
application/json
{
  • "columns": [
    ],
  • "metaData": {
    },
  • "results": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 201,
  • "resultSetId": 50
}

Update Results

Upload results for given event, sub-event and result set ID.

path Parameters
eventId
required
string

Event ID.

Responses

Response samples

Content type
application/json
{
  • "code": 501,
  • "message": "Not implemented"
}

Delete all results

Delete all results for event.

path Parameters
eventId
required
string

Event ID.

query Parameters
deleteProcessedResults
boolean
Default: "false"
Example: deleteProcessedResults=false

Delete processed online results

Responses

Delete results

Delete results set for event and results set ID.

path Parameters
eventId
required
string

Event ID

resultsSetId
required
string

Results Set ID

query Parameters
deleteProcessedResults
boolean
Default: "false"
Example: deleteProcessedResults=false

Delete processed online results

Responses

Upload Race Results

This will upload a new set of results for a specific event and race, without over writing any previously uploaded results.

Results can be uploaded in the form of a comma separated value (CSV) file.

The API only accepts CSV files:

  • Content-Type: text/csv header is required when sending

The file containing the results is uploaded and added to the results processing queue. The uploaded results file can later be managed by using the results dashboard on timer.raceroster.com

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Race Result ID

Request Body schema: text/csv
required
string <binary>

Responses

Request samples

Content type
text/csv
Overall,Bib,First name,Last name,Sex,Age Group,Gun time,Chip time
  1,101,John,Doe,M,M30-39,25:30,25:15
  2,102,Jane,Smith,F,F30-39,26:10,25:55

Response samples

Content type
application/json
{
  • "code": 201,
  • "resultSetId": 50
}

Upload Race Results PDF

This will upload a single PDF file containing results for a specific event and race. Any existing results will be overwritten. There can be only one PDF file per race.

Results can be uploaded in the form of a Portable Document Format (PDF) file with mime type: application/pdf.

The PDF file containing the results is uploaded and stored on the results Content Delivery Network (CDN) and the response contains the file URL to view the PDF from the CDN.

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Race Result ID

Responses

Upload Race Results text

This will upload a single text file containing unstructured results for a specific event and race. Any existing results will be overwritten. There can be only one text file per race.

Results can be uploaded in the form of a text (txt) file with mime type: text/plain.

path Parameters
eventId
required
string

Event ID

resultsRaceId
required
string

Race Result ID

Request Body schema: text/plain
required
string <binary>

Responses

Request samples

Content type
text/plain
5K Results
  Overall Bib   Name       Sex Age Group Gun Time  Chip Time
  1       101   John Doe   M   M30-39    25:30     25:15
  2       102   Jane Smith F   F30-39    26:10     25:55

Response samples

Content type
application/json
{
  • "code": 201,
  • "resultSetId": 51
}