{"_id":"564b8436cc472d0d00da9455","editedParams":true,"project":"55773a5ba042551900b002cb","__v":1,"version":{"_id":"55773a5ba042551900b002ce","project":"55773a5ba042551900b002cb","__v":18,"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","59cd4b81935249001c77c48e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Motherboard","version_clean":"1.0.0","version":"1"},"category":{"_id":"55773acb07e7110d001043ee","pages":["55776c5f07e7110d00104499","564b840485e4e92b00fb4f9d","564b8422cc472d0d00da9453","564b8436cc472d0d00da9455","564b84471ed5c823003eb662","564b84591ed5c823003eb664","564b8468766d4923004e1fcd","564b84944f06ef2b006b08b2","564b84a0766d4923004e1fcf"],"__v":9,"project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-09T19:13:15.370Z","from_sync":false,"order":7,"slug":"federation-api","title":"Federation API"},"parentDoc":null,"user":"546d17e2eb9cfd1400dd4529","editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T19:47:02.747Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","code":"{\n   \"code\":200,\n   \"status\":\"success\",\n   \"data\":{\n      \"federation_id\":2356,\n      \"federation_title\":\"British Triathlon Federation\",\n      \"federation_slug\":\"british_triathlon_federation\",\n      \"federation_edit_date\":\"2016-06-03T16:50:55+00:00\",\n      \"federation_country_id\":292,\n      \"federation_region_id\":10,\n      \"federation_region_name\":\"Europe\",\n      \"federation_affiliation_status\":\"Affiliated\",\n      \"federation_noc\":\"GBR\",\n      \"federation_country_name\":\"Great Britain\",\n      \"federation_country_isoa2\":\"GB\",\n      \"federation_flag\":\"https://f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com/images/icons/gb.png\",\n      \"federation_listing\":\"http://europe.triathlon.org/federations/federation/british_triathlon_federation\",\n      \"federation_api_listing\":\"https://api.triathlon.org/v1/v1/federations/2356\",\n      \"president_name\":\"Ian Howard\",\n      \"secretary_general_name\":null,\n      \"ceo_name\":\"Jack Buckner\",\n      \"website\":\"http://www.britishtriathlon.org/\",\n      \"logo\":\"http://www.triathlon.org/uploads/federations/BTF_Logo.jpg\",\n      \"information\":null,\n      \"date_founded\":\"1982-01-01\",\n      \"affiliation_date\":null,\n      \"address\":{\n         \"street\":\"PO Box 25\",\n         \"city\":\"Loughborough\",\n         \"state\":\"Leicestershire\",\n         \"zipcode\":\"LE11 3WX\"\n      },\n      \"email\":{\n         \"admin_email\":\"info:::at:::britishtriathlon.org\",\n         \"president_email\":\"ianhoward@britishtriathlon.org\",\n         \"secretary_general_email\":\"emmagood@britishtriathlon.org\",\n         \"ceo_email\":\"jackbuckner@britishtriathlon.org\",\n         \"high_performance_email\":\"lauramacey@britishtriathlon.org, emmagood@britishtriathlon.org\",\n         \"age_group_email\":\"agegroup@britishtriathlon.org\"\n      },\n      \"contact\":{\n         \"phone\":\"+44 1509226161\",\n         \"fax\":null\n      },\n      \"federation_total_athletes\":8345,\n      \"federation_current_elite_athletes\":66,\n      \"latest_news\":[\n         {\n            \"news_id\":88943,\n            \"news_title\":\"Director of Triathlon Loughborough University\",\n            \"news_slug\":\"director_of_triathlon_loughborough_university\",\n            \"news_entry_date\":\"2014-07-25T16:54:50Z\",\n            \"news_excerpt\":null,\n            \"news_thumbnail\":\"http://www.triathlon.org/images/news_thumbs/loughborough_logo13-012908.gif\",\n            \"news_tab_image\":null,\n            \"news_multipurpose_image\":null,\n            \"news_url\":\"http://www.triathlon.org/news/article/director_of_triathlon_loughborough_university\",\n            \"news_api_url\":\"https://api.triathlon.org/content/news/88943\",\n            \"news_categories\":[\n               {\n                  \"cat_name\":\"ITU\",\n                  \"cat_id\":52,\n                  \"cat_parent_id\":null\n               }\n            ]\n         }\n      ],\n      \"upcoming_events\":[\n         {\n            \"event_id\":107161,\n            \"event_title\":\"2017 ITU World Triathlon Leeds\",\n            \"event_slug\":\"2017_itu_world_triathlon_leeds\",\n            \"event_edit_date\":\"2017-06-10T00:00:00+00:00\",\n            \"event_venue\":\"Leeds\",\n            \"event_country\":\"Great Britain\",\n            \"event_latitude\":0,\n            \"event_longitude\":0,\n            \"event_date\":\"2017-06-10\",\n            \"event_finish_date\":\"2017-06-11\",\n            \"event_country_isoa2\":\"GB\",\n            \"event_country_noc\":\"GBR\",\n            \"event_region_id\":10,\n            \"event_country_id\":292,\n            \"event_region_name\":\"Europe\",\n            \"event_categories\":[\n               {\n                  \"cat_name\":\"World Triathlon Series\",\n                  \"cat_id\":351,\n                  \"cat_parent_id\":null\n               }\n            ],\n            \"event_specifications\":[\n               {\n                  \"cat_name\":\"Triathlon\",\n                  \"cat_id\":357,\n                  \"cat_parent_id\":null\n               }\n            ],\n            \"event_flag\":\"https://f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com/images/icons/gb.png\",\n            \"event_listing\":\"http://www.triathlon.org/events/event/2017_itu_world_triathlon_leeds\",\n            \"event_api_listing\":\"https://api.triathlon.org/v1/v1/events/107161\"\n         }\n      ]\n   }\n}","language":"json"}]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[{"_id":"565ca3372206890d00ba04d0","ref":"","in":"path","required":true,"desc":"The unique id of the Federation to be returned","default":"","type":"int","name":"federation_id"}],"url":"/federations/:federation_id"},"isReference":true,"order":2,"body":"The **Retrieve Federation Information** endpoint returns a detailed listing for a Federation given a `federation_id`.\n\nAs well as listing the basic Federation information it also includes a list of the latest news articles together with any upcoming events for the Federation.\n\nThe following example retrieves the Federation profile for the British Triathlon Federation (federation_id 2356).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: [[app:key]]\\\" https://api.triathlon.org/v1/federations/2356\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"retrieve-federation-information","type":"endpoint","title":"Retrieve Federation Information"}

getRetrieve Federation Information


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

federation_id:
required
integer
The unique id of the Federation to be returned

Result Format


Documentation

The **Retrieve Federation Information** endpoint returns a detailed listing for a Federation given a `federation_id`. As well as listing the basic Federation information it also includes a list of the latest news articles together with any upcoming events for the Federation. The following example retrieves the Federation profile for the British Triathlon Federation (federation_id 2356). [block:code] { "codes": [ { "code": "curl --header \"apikey: [[app:key]]\" https://api.triathlon.org/v1/federations/2356", "language": "curl" } ] } [/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 }}