{"__v":1,"_id":"564a00823242592b00338a26","category":{"__v":9,"_id":"55773ad3a042551900b002d6","pages":["563a51bddaf1c00d00136dc8","563a583ac8baa517009d07e7","563a5861a19edf0d00972340","563a5870c8baa517009d07ea","563a589a4cc3621900ac2770","563a58b3c8baa517009d07ed","563a58c7e1313f0d00c8679a","563a58ea4cc3621900ac2779","564a00823242592b00338a26"],"project":"55773a5ba042551900b002cb","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,"parentDoc":null,"project":"55773a5ba042551900b002cb","user":"546d17e2eb9cfd1400dd4529","version":{"__v":17,"_id":"55773a5ba042551900b002ce","project":"55773a5ba042551900b002cb","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-16T16:12:50.488Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"code\":200,\n   \"status\":\"success\",\n   \"data\":[\n      {\n         \"prog_name\":\"Elite Men\",\n         \"prog_id\":275363,\n         \"title\":\"2014 Horst ETU Powerman Long Distance and Sprint Duathlon European Championships\",\n         \"slug\":\"2014_horst_etu_powerman_long_distance_and_sprint_duathlon_european_champion\",\n         \"date\":\"2014-04-12\",\n         \"event_type\":3,\n         \"cutoff_time\":false,\n         \"period\":2,\n         \"max_points\":600,\n         \"max_positions\":15,\n         \"deduction\":0,\n         \"override\":true,\n         \"qof\":100,\n         \"prog_override\":265759,\n         \"event_id\":80702,\n         \"event_container\":false,\n         \"region_name\":\"Europe\",\n         \"region_id\":10\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":"564a37f8f176080d000c799d","ref":"","in":"query","required":false,"desc":"The date to be used for the rankings calculation","default":"","type":"yyyy-mm-dd","name":"date"}],"url":"/rankings/:ranking_id/events"},"isReference":true,"order":3,"body":"This method retrieves all events (and associated information) used in the calculation of a ranking. This method is critical in determining the events to be included as well as required parameters such as the quality of field or event deductions to be accounted for in calculations.\n\nWhilst each ranking will vary according to the [specified criteria](http://www.triathlon.org/about/downloads/category/ranking_criteria) the following guidelines may be used:\n\n* The **override** key indicates whether a 'Rankings Only' program has been used to generate the results. If set to true then **prog_override** key indicates the prog_id to be used for rankings calculation.\n* The **deduction **key indicates the % deduction to be used for the points which may vary from 0 to 100%.\n* The **cutoff_time** is the value in seconds of the cuttoff_time to be applied if applicable. A value of false indicates that the cutoff_time is not used in the ranking calculation.\n* The **event_type** key corresponds to the associated ranking criteria definition level of event.\n* The **qof** key represents the 'Quality of Field' factor. This value is presented as a percentage with the value ranking from 100% to 120%.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Ranking Events\",\n  \"body\": \"In certain rankings National Federation can choose to include one of the relevant distance National Championships in the rankings (e.g. either standard or sprint) so this must be consulted to determine which events have been chosen for inclusion.\"\n}\n[/block]","excerpt":"","slug":"ranking-events","type":"endpoint","title":"Ranking Events"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ranking_id:
required
integer
The id of the ranking

Query Params

date:
yyyy-mm-dd
The date to be used for the rankings calculation

Result Format


Documentation

This method retrieves all events (and associated information) used in the calculation of a ranking. This method is critical in determining the events to be included as well as required parameters such as the quality of field or event deductions to be accounted for in calculations. Whilst each ranking will vary according to the [specified criteria](http://www.triathlon.org/about/downloads/category/ranking_criteria) the following guidelines may be used: * The **override** key indicates whether a 'Rankings Only' program has been used to generate the results. If set to true then **prog_override** key indicates the prog_id to be used for rankings calculation. * The **deduction **key indicates the % deduction to be used for the points which may vary from 0 to 100%. * The **cutoff_time** is the value in seconds of the cuttoff_time to be applied if applicable. A value of false indicates that the cutoff_time is not used in the ranking calculation. * The **event_type** key corresponds to the associated ranking criteria definition level of event. * The **qof** key represents the 'Quality of Field' factor. This value is presented as a percentage with the value ranking from 100% to 120%. [block:callout] { "type": "warning", "title": "Ranking Events", "body": "In certain rankings National Federation can choose to include one of the relevant distance National Championships in the rankings (e.g. either standard or sprint) so this must be consulted to determine which events have been chosen for inclusion." } [/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 }}