{"_id":"563a5861a19edf0d00972340","category":{"_id":"55773ad3a042551900b002d6","pages":["563a51bddaf1c00d00136dc8","563a583ac8baa517009d07e7","563a5861a19edf0d00972340","563a5870c8baa517009d07ea","563a589a4cc3621900ac2770","563a58b3c8baa517009d07ed","563a58c7e1313f0d00c8679a","563a58ea4cc3621900ac2779","564a00823242592b00338a26"],"project":"55773a5ba042551900b002cb","__v":9,"version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-09T19:13:23.707Z","from_sync":false,"order":4,"slug":"rankings-api","title":"Rankings API"},"editedParams":true,"editedParams2":true,"version":{"_id":"55773a5ba042551900b002ce","project":"55773a5ba042551900b002cb","__v":17,"createdAt":"2015-06-09T19:11:23.764Z","releaseDate":"2015-06-09T19:11:23.764Z","categories":["55773a5ca042551900b002cf","55773a6ce6063e0d00481380","55773ab007e7110d001043ec","55773abaa042551900b002d5","55773ac207e7110d001043ed","55773acb07e7110d001043ee","55773ad3a042551900b002d6","55773adce6063e0d00481383","55773ae4a042551900b002d7","55773af307e7110d001043ef","55773af907e7110d001043f0","55773b0407e7110d001043f1","563a4f7ad25e8919005f3f39","563a4fcaa19edf0d00972321","564a70dc4cd0521700523edf","564b797bcc472d0d00da9435","564b855b766d4923004e1fd1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Motherboard","version_clean":"1.0.0","version":"1"},"project":"55773a5ba042551900b002cb","user":"546d17e2eb9cfd1400dd4529","parentDoc":null,"__v":5,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-04T19:11:29.652Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","name":"","code":""}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"code\":200,\n   \"status\":\"success\",\n   \"data\":{\n      \"ranking_id\":1,\n      \"ranking_cat_id\":1,\n      \"ranking_name\":\"Men's PT1\",\n      \"published\":\"2016-01-04 11:00:01\",\n      \"region_id\":null,\n      \"week\":\"2016-W01\",\n      \"region_name\":null,\n      \"rankings\":[\n         {\n            \"athlete_id\":74558,\n            \"athlete_title\":\"Krige Schabort\",\n            \"athlete_slug\":\"krige_schabort\",\n            \"athlete_first\":\"Krige\",\n            \"athlete_last\":\"Schabort\",\n            \"athlete_country_id\":293,\n            \"athlete_gender\":\"male\",\n            \"athlete_yob\":\"1963\",\n            \"validated\":false,\n            \"athlete_profile_image\":null,\n            \"athlete_noc\":\"USA\",\n            \"athlete_country_name\":\"United States\",\n            \"athlete_country_isoa2\":\"US\",\n            \"athlete_listing\":\"http:\\/\\/www.triathlon.org\\/athletes\\/profile\\/74558\\/krige_schabort\",\n            \"athlete_flag\":\"https:\\/\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\/images\\/icons\\/us.png\",\n            \"athlete_api_listing\":\"https:\\/\\/api.triathlon.org\\/v1\\/v1\\/athletes\\/74558\",\n            \"athlete_categories\":[\n               39\n            ],\n            \"rank\":1,\n            \"last_rank\":1,\n            \"change\":0,\n            \"last_total\":1723.33,\n            \"total\":1723.33,\n            \"total_current_period\":1397.5,\n            \"total_previous_period\":325.83,\n            \"events_current_period\":3,\n            \"events_previous_period\":2,\n            \"current_period_1\":647.5,\n            \"current_period_2\":450,\n            \"current_period_3\":450,\n            \"previous_period_1\":233.33,\n            \"previous_period_2\":92.5,\n            \"previous_period_3\":0\n         },\n         {\n            \"athlete_id\":32627,\n            \"athlete_title\":\"Bill Chaffey\",\n            \"athlete_slug\":\"bill_chaffey\",\n            \"athlete_first\":\"Bill\",\n            \"athlete_last\":\"Chaffey\",\n            \"athlete_country_id\":111,\n            \"athlete_gender\":\"male\",\n            \"athlete_yob\":\"1975\",\n            \"validated\":false,\n            \"athlete_profile_image\":null,\n            \"athlete_noc\":\"AUS\",\n            \"athlete_country_name\":\"Australia\",\n            \"athlete_country_isoa2\":\"AU\",\n            \"athlete_listing\":\"http:\\/\\/www.triathlon.org\\/athletes\\/profile\\/32627\\/bill_chaffey\",\n            \"athlete_flag\":\"https:\\/\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\/images\\/icons\\/au.png\",\n            \"athlete_api_listing\":\"https:\\/\\/api.triathlon.org\\/v1\\/v1\\/athletes\\/32627\",\n            \"athlete_categories\":[\n               39\n            ],\n            \"rank\":2,\n            \"last_rank\":2,\n            \"change\":0,\n            \"last_total\":1700,\n            \"total\":1700,\n            \"total_current_period\":1450,\n            \"total_previous_period\":250,\n            \"events_current_period\":3,\n            \"events_previous_period\":2,\n            \"current_period_1\":700,\n            \"current_period_2\":450,\n            \"current_period_3\":450,\n            \"previous_period_1\":150,\n            \"previous_period_2\":100,\n            \"previous_period_3\":0\n         }\n      ]\n   }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"563a5c9ce1313f0d00c867af","ref":"","in":"path","required":true,"desc":"The id of the ranking","default":"","type":"int","name":"ranking_id"},{"_id":"5642284bb0dc090d00f88452","ref":"","in":"query","required":false,"desc":"Code to display unpublished rankings","default":"","type":"string","name":"break_cache"}],"url":"/rankings/:ranking_id"},"isReference":true,"order":2,"body":"The **Ranking Detail** method returns the output of a specified ranking and contains all the summary information required for basic ranking information. A [Rankings Listing](https://triathlon-api.readme.io/docs/rankings-listing) object is returned containing the summary information about the ranking returned while the rankings themselves are contained within a corresponding rankings object.\n\nThe rankings object is specific to the ranking in question and you should consult the [ranking criteria](http://www.triathlon.org/about/downloads/category/ranking_criteria) for the specifics about each ranking.\n\nFor futher information about each athlete's score you should consult the [Athlete Ranking Breakdown](https://triathlon-api.readme.io/docs/athlete-ranking-breakdown) method which provides an event-by-event analysis of each score obtained.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Cache Buster Link\",\n  \"body\": \"For authenticated users only by providing a break_cache parameter you can view the latest rankings that have been run but not published for preview viewing.\"\n}\n[/block]","excerpt":"","slug":"ranking-detail","type":"endpoint","title":"Ranking Detail"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ranking_id:
required
integer
The id of the ranking

Query Params

break_cache:
string
Code to display unpublished rankings

Result Format


Documentation

The **Ranking Detail** method returns the output of a specified ranking and contains all the summary information required for basic ranking information. A [Rankings Listing](https://triathlon-api.readme.io/docs/rankings-listing) object is returned containing the summary information about the ranking returned while the rankings themselves are contained within a corresponding rankings object. The rankings object is specific to the ranking in question and you should consult the [ranking criteria](http://www.triathlon.org/about/downloads/category/ranking_criteria) for the specifics about each ranking. For futher information about each athlete's score you should consult the [Athlete Ranking Breakdown](https://triathlon-api.readme.io/docs/athlete-ranking-breakdown) method which provides an event-by-event analysis of each score obtained. [block:callout] { "type": "info", "title": "Cache Buster Link", "body": "For authenticated users only by providing a break_cache parameter you can view the latest rankings that have been run but not published for preview viewing." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}