{"_id":"563a58c7e1313f0d00c8679a","__v":1,"editedParams":true,"editedParams2":true,"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"},"parentDoc":null,"project":"55773a5ba042551900b002cb","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"},"user":"546d17e2eb9cfd1400dd4529","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-04T19:13:11.767Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n   \"code\":200,\n   \"status\":\"success\",\n   \"data\":{\n      \"ranking_id\":1,\n      \"ranking_name\":\"Men's PT1\",\n      \"ranking_cat_id\":1,\n      \"ranking_category_name\":\"Paratriathlon\",\n      \"published\":\"2015-11-06 19:35:36\",\n      \"region_id\":null,\n      \"week\":\"2015-W45\",\n      \"region_name\":null,\n      \"rankings\":{\n         \"rank\":1,\n         \"last_rank\":1,\n         \"change\":0,\n         \"last_week_score\":1800,\n         \"athlete_id\":32627,\n         \"athlete_slug\":\"bill_chaffey\",\n         \"athlete_first\":\"Bill\",\n         \"athlete_last\":\"Chaffey\",\n         \"athlete_nat\":\"AUS\",\n         \"athlete_flag\":\"https:\\/\\/cdn.triathlon.org\\/images\\/icons\\/au.png\",\n         \"athlete_yob\":\"1975\",\n         \"total_score\":1800,\n         \"score_current_period\":1450,\n         \"score_prev_period\":350,\n         \"events_current_period\":3,\n         \"events_prev_period\":3,\n         \"current_period_1\":700,\n         \"current_period_2\":450,\n         \"current_period_3\":300,\n         \"prev_period_1\":150,\n         \"prev_period_2\":100,\n         \"prev_period_3\":100\n      },\n      \"breakdown\":[\n         {\n            \"event_id\":90168,\n            \"event_title\":\"2015 ITU World Triathlon Grand Final Chicago\",\n            \"event_slug\":\"2015_itu_world_triathlon_grand_final_chicago\",\n            \"event_date\":\"2015-09-15\",\n            \"event_type\":1,\n            \"prog_id\":272186,\n            \"points\":700,\n            \"position\":1,\n            \"total_time\":\"00:58:38\",\n            \"notes\":\"\",\n            \"period\":1,\n            \"event_container\":0,\n            \"override_prog_id\":0,\n            \"override_prog_time\":\"\",\n            \"event_deduction\":0,\n            \"original_position\":\"\",\n            \"include\":true\n         }\n      ]\n   }\n}","language":"json","status":200}]},"settings":"","method":"get","auth":"required","params":[{"_id":"563a601ac63a22190018dcd9","ref":"","in":"path","required":true,"desc":"The id of the ranking","default":"","type":"int","name":"ranking_id"},{"_id":"563a601ac63a22190018dcd8","ref":"","in":"path","required":true,"desc":"The id of the athlete","default":"","type":"int","name":"athlete_id"}],"url":"/rankings/:ranking_id/breakdown/:athlete_id"},"isReference":true,"order":4,"body":"This **Athlete Ranking Breakdown** method returns detailed ranking information for an athlete. It provides the result of all events that are contained within a ranking criteria and contains detailed information as to the status of that event.\n\nA basic athlete object and ranking listing object are returned with all rankings details contained within the breakdown object.\n\nThe output of the breakdown object is ranking specific and you should consult each [ranking criteria](http://www.triathlon.org/about/downloads/category/ranking_criteria) for more information but the following guidelines may be used:\n\n* For events with multiple periods the current period is designated as 1 and the prior period 2.\n* The event type corresponds to the points level listed on each ranking criteria which is used to determine the number of scoring positions and maximum number of points.\n* For some ranking criteria the results of the event are modified according to the ranking criteria (e.g. where non-continental athletes are in the results of a Continental event). In these cases the prog_id refers to the results used and the original results are available in the **override_prog_id**. Similarly the override_prog_time and original_position may be used for the raw non-modified data.\n* The boolean **include** value displays whether this score has been included in the ranking score\n* For events that are within a separate event e.g. a National Championship event taking place in a Continental Cup the **event_container ** key will show the event_id of the containing event.\n* If the event has been modified and a deduction is applicable the % deduction will be shown\n* The **notes **key contains specific information as to why the score has not been included if applicable\n\nFor further information about each event you may also consult the [Ranking Events](https://triathlon-api.readme.io/docs/ranking-events) method.","excerpt":"","slug":"athlete-ranking-breakdown","type":"endpoint","title":"Athlete Ranking Breakdown"}

getAthlete Ranking Breakdown


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ranking_id:
required
integer
The id of the ranking
athlete_id:
required
integer
The id of the athlete

Result Format


Documentation

This **Athlete Ranking Breakdown** method returns detailed ranking information for an athlete. It provides the result of all events that are contained within a ranking criteria and contains detailed information as to the status of that event. A basic athlete object and ranking listing object are returned with all rankings details contained within the breakdown object. The output of the breakdown object is ranking specific and you should consult each [ranking criteria](http://www.triathlon.org/about/downloads/category/ranking_criteria) for more information but the following guidelines may be used: * For events with multiple periods the current period is designated as 1 and the prior period 2. * The event type corresponds to the points level listed on each ranking criteria which is used to determine the number of scoring positions and maximum number of points. * For some ranking criteria the results of the event are modified according to the ranking criteria (e.g. where non-continental athletes are in the results of a Continental event). In these cases the prog_id refers to the results used and the original results are available in the **override_prog_id**. Similarly the override_prog_time and original_position may be used for the raw non-modified data. * The boolean **include** value displays whether this score has been included in the ranking score * For events that are within a separate event e.g. a National Championship event taking place in a Continental Cup the **event_container ** key will show the event_id of the containing event. * If the event has been modified and a deduction is applicable the % deduction will be shown * The **notes **key contains specific information as to why the score has not been included if applicable For further information about each event you may also consult the [Ranking Events](https://triathlon-api.readme.io/docs/ranking-events) method.

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 }}