Results

Import Results

REST Pattern [Post Only]: results/import?key=

Description: Import your results to a linked Athlinks event and course.

Example: Accepts a payload with 3rd party results data.

{
  "ThirdPartyEventId": "010-2017",
  "ThirdPartyRaceId": "010-2017-10K",
  "Finalize": true,
  "ImportResultsType": "DeleteExisting",
  "TotalLegs": 1,
  "Entries": [{
    "ThirdPartyEntryId": "10K-JerikaV",
    "FirstName": "Jerika",
    "LastName": "Van",
    "Suffix": "",
    "Sponsor": "",
    "Tags": ["F25-29", "ANGL"],
    "Age": 26,
    "Gender": "F",
    "City": "Westminster",
    "State": "CO",
    "Country": "USA",
    "BibNum": "45678",
    "Email": "jerika.van@athlinks.com",
    "LegTimes": ["00:41:22"],
    "FinalTime": "00:41:22",
    "Place": 10,
    "EntryType": "IND",
    "PrimaryBracketId": null,
    "PrimaryBracketName": "F25-29"
  }, {
    ...
  }],
  "RaceBrackets": [{
    "BracketId": 1,
    "ParentBracketId": 0,
    "Tag": "ALL",
    "Name": "Overall",
    "EntryType": "I",
    "RankType": "G",
    "Type": 1,
    "Gender": null,
    "MinAge": null,
    "MaxAge": null,
    "DisplayOrder": null,
    "WantsLeaderboard": true,
    "Specificity": 199
  }, {
    "BracketId": 2,
    "ParentBracketId": 1,
    "Type": 2,
    "Tag": "F",
    "Name": "Female Overall",
    "EntryType": "I",
    "RankType": "G",
    "Gender": "F",
    "MinAge": null,
    "MaxAge": null,
    "DisplayOrder": null,
    "WantsLeaderboard": true,
    "Specificity": 198
  },
  ..., {
    "BracketId": 10,
    "ParentBracketId": 2,
    "Type": 2,
    "Tag": "F25-29",
    "Name": "Female 25-29",
    "EntryType": "I",
    "RankType": "G",
    "Gender": "F",
    "MinAge": 25,
    "MaxAge": 29,
    "DisplayOrder": null,
    "WantsLeaderboard": true,
    "Specificity": 197
  },
  ..., {
    "BracketId": 42,
    "ParentBracketId": 1,
    "Type": 5,
    "Tag": "ANGL",
    "Name": "Angels",
    "EntryType": "I",
    "RankType": "G",
    "Gender": null,
    "MinAge": null,
    "MaxAge": null,
    "DisplayOrder": null,
    "WantsLeaderboard": true,
    "Specificity": 195
  }]
}

Field Definitions & Usage:

Field Name	Possible Values
ThirdPartyEventId	The unique event id that is linked to an Athlinks event.
ThirdPartyRaceId	The unique race id that is linked to an Athlinks course.
Finalize	true | false Indicates whether these results should appear immediately after processing. You'll almost always want this to be true.
ImportResultsType	NewUpload | AppendResults | DeleteExisting
TotalLegs	Corresponds to the total number of elements being included in the LegTimes property for each element in the Entries collection.
Entries	Field Name Possible Values ThirdPartyEntryId The unique identifier for a given entry in your system. FirstName The athlete's first name. LastName The athlete's last name. Suffix Jr. | Sr. | I | II, etc. Sponsor Free-form text. Tags Used for bracket classification. NOTE: These tags should exactly match the Tag value for a given RaceBracket, e.g. "F25-29", "Masters", "MAST", "CLY", etc. Age The athlete's age on race day. Gender M | F | U City The hometown or city of the athlete. State The state or region in which the event is taking place. Use the 2- or 3-digit locale code for the state as defined by ISO-3166 Country The country in which the event is taking place. Use the 2- or 3-digit locale code for the country as defined by ISO 3166-1 alpha-2 BibNum The athlete's bib number. Email The athlete's email address. LegTimes A collection of times representing each leg of the race. FinalTime The athlete's overall time to complete the race. Place The athlet's ranking in their Primary Bracket, typically Overall. EntryType IND | TEAM PrimaryBracketId The unique id of the athlete's primary bracket, typically Overall, corresponding to an element in the RaceBrackets collection. PrimaryBracketName The unique name of the athlete's primary bracket, typically Overall, corresponding to an element in the RaceBrackets collection.
RaceBrackets	Field Name Possible Values BracketId 0 - 999999 The unique id of the bracket in your system. ParentBracketId 0 - 999999 The bracket to which this bracket belongs. NOTE: If the bracket does not have a parent, use 0. Type 1 (overall) | 2 (gender) | 3 (age class) | 4 (elite) | 5 (other) Tag ALL | M (male) | F (female) | U (unspecified) | R (relay) EXAMPLE: If Type = Use 1 ALL 2 F | M 3 1-6 | 7-8 | ... | 95-99 4 F | M | R 5 U | R EntryType I (individual) | T (team) RankType G (gun) | C (chip) Gender M | F | U | null EXAMPLE: If Tag = Use F F M M U U MinAge 0 - 99 | null NOTE: Should be less than MaxAge value. MaxAge 0 - 99 | null NOTE: Should be greater than MinAge value. DisplayOrder 0 - 99 | null Determines in which order the bracket is displayed at www.athlinks.com WantsLeaderboard true | false Indicates whether this bracket should have a Top 10 Leaderboard displayed at www.athlinks.com Specificity 199 (overall) | 198 (gender) | 197 (age class) | 196 (elite) | 195 (other) | null

Returns: A 200 OK response.

{
  "ResponseCode": 0,
  "ErrorMessage": ""
}

NOTE: Your results will be processed asynchronously and may take a few minutes to appear on www.athlinks.com

Results Details

Lookup a Single Result Detail by ID.

REST Pattern: results/{id}

Description: Returns the details of a result by ID.

Example: results/29510

Search Unclaimed Results by Athlete Name

Search for unclaimed results by Athlete name.

REST Pattern: results/search/{*name}

Description: Returns a list of Race Results by Athlete name. This will only return results that have not been claimed by a member.

Additional Parameters:

• Includeclaimed {bool}: Set to true to show claimed results for Athlinks members. Default value is false.

Example: results/search/troy+busot OR results/search/?name=troy%20busot

(Updated: 10/22/2010) Added QueryString search parameters.

Search for unclaimed results by Athlete name and Age Range

REST Pattern: results/search/{name}/{ageFloor}-{ageCeiling}

Description: Returns a list of Race Results by Athlete name and age range (low to high). This will only return results that have not been claimed by a member.

Additional Parameters:

• Includeclaimed {bool}: Set to true to show claimed results for Athlinks members. Default value is false.

Example: results/search/troy+busot/20-40

Search for unclaimed results by Athlete name, Age Range, and State/Provinces where results occurred.

REST Pattern: results/search/{name}/{ageFloor}-{ageCeiling}/{StateProvIDs}

Description: Returns a list of Race Results by Athlete name and age range (low to high), and StateProvIDs. This will only return results that have not been claimed by a member.

Additional Parameters:

• Includeclaimed {bool}: Set to true to show claimed results for Athlinks members. Default value is false.

Example: results/search/troy+busot/20-40/us_az

Find "Other" states with Result Counts for a given athlete search.

REST Pattern: results/search_counts/{name}/{ageFloor}-{ageCeiling}/{StateProvIDs}

Description: Returns a list of States/Provinces with Race Counts for each terribory by Athlete name and age range (low to high), and StateProvIDs. This will only return results that have not been claimed by a member.

Additional Parameters:

• Includeclaimed {bool}: Set to true to show claimed results for Athlinks members. Default value is false.

Example: results/search_counts/troy+busot/20-40/us_az

Claim Results

Save unclaimed results entries to a member athlete account.

REST Pattern [Post Only]: results/claim

Description: Takes an Athlete ID and one or more Results IDs and creates a Merge request to save Results to that Athlete's account.

Example: results/claim

Return Code: 200: Successful Claim;

Team Results/Standings

Retrieve a list of team aggregate results for a given Event or specific Race.

REST Pattern [GET Only]: /results/list/{eventid}/teams/?courseID={courseid}&scoreTop={number of races per athlete to score}&byGender={true|false}

Description: Takes an Event ID, (optionally) CourseID, ScoreTop, and ByGender parameters to return a Team-based leaderboard for an Event or specific Race(s).

Example: results/list/922466/teams/?courseid=0&scoreTop=5&byGender=true