{"__v":3,"_id":"564b84c0cc472d0d00da9459","category":{"__v":7,"_id":"55773af907e7110d001043f0","pages":["564b84b2cc472d0d00da9457","564b84c0cc472d0d00da9459","564b84d44f06ef2b006b08b4","564b84eddda79a19000f266e","564b84f9e6c67c2f0038366a","564b850585e4e92b00fb4fa0","5668a50cee1dbf0d008f62dc"],"project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-09T19:14:01.892Z","from_sync":false,"order":8,"slug":"courses-api","title":"Courses 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-17T19:49:20.304Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"code\":200,\n   \"status\":\"success\",\n   \"total\":386,\n   \"per_page\":10,\n   \"current_page\":1,\n   \"last_page\":39,\n   \"next_page_url\":\"https:\\/\\/api.triathlon.org\\/v1\\/courses?page=2\",\n   \"prev_page_url\":null,\n   \"from\":1,\n   \"to\":10,\n   \"data\":[\n      {\n         \"course_id\":102953,\n         \"course_title\":\"2016 Utrecht ITU Technical Officials Level 1 Seminar\",\n         \"course_edit_date\":\"2015-12-23T06:46:23+00:00\",\n         \"course_slug\":\"2016_utrecht_itu_technical_officials_level_1_seminar\",\n         \"course_venue\":\"Utrecht\",\n         \"course_language\":\"English\",\n         \"course_country_name\":\"Netherlands\",\n         \"course_latitude\":52.09074,\n         \"course_longitude\":5.12142,\n         \"course_date\":\"2016-04-09\",\n         \"course_finish_date\":null,\n         \"course_country_isoa2\":\"NL\",\n         \"course_noc\":\"NED\",\n         \"course_region_id\":10,\n         \"course_country_id\":230,\n         \"course_region_name\":\"Europe\",\n         \"course_categories\":[\n            {\n               \"cat_name\":\"Technical Officials\",\n               \"cat_id\":236,\n               \"cat_parent_id\":0\n            },\n            {\n               \"cat_name\":\"TO Level 1\",\n               \"cat_id\":239,\n               \"cat_parent_id\":236\n            }\n         ],\n         \"course_flag\":\"https:\\/\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\/images\\/icons\\/nl.png\",\n         \"course_listing\":\"http:\\/\\/www.triathlon.org\\/development\\/course\\/2016_utrecht_itu_technical_officials_level_1_seminar\",\n         \"course_api_listing\":\"https:\\/\\/api.triathlon.org\\/v1\\/v1\\/federations\\/102953\"\n      }\n   ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5668b3821962500d00c30f03","ref":"","in":"query","required":false,"desc":"How many courses to be returned per page","default":"10","type":"int","name":"per_page"},{"_id":"5668b3821962500d00c30f02","ref":"","in":"query","required":false,"desc":"The page number to be returned","default":"","type":"int","name":"page"},{"_id":"5668b3821962500d00c30f01","ref":"","in":"query","required":false,"desc":"A pipe delimited list of category ids","default":"","type":"string","name":"category_id"},{"_id":"5668b3821962500d00c30f00","ref":"","in":"query","required":false,"desc":"Restrict returned courses by name","default":"","type":"string","name":"name"},{"_id":"5668b3821962500d00c30eff","ref":"","in":"query","required":false,"desc":"The earliest date for courses to be returned","default":"","type":"string","name":"start_date"},{"_id":"5668b3821962500d00c30efe","ref":"","in":"query","required":false,"desc":"The latest date for courses to be returned","default":"","type":"string","name":"end_date"},{"_id":"5668b3821962500d00c30efd","ref":"","in":"query","required":false,"desc":"A pipe delimited list of region ids","default":"","type":"string","name":"region_id"},{"_id":"5668b3821962500d00c30efc","ref":"","in":"query","required":false,"desc":"A pipe delimited list of country ids","default":"","type":"string","name":"country_id"},{"_id":"5668b3821962500d00c30efb","ref":"","in":"query","required":false,"desc":"A pipe delimited list of course ids","default":"","type":"string","name":"course_id"},{"_id":"56b96c689bef640d00bd50a1","ref":"","in":"query","required":false,"desc":"The language of the course","default":"","type":"string","name":"language"},{"_id":"56b96c689bef640d00bd50a0","ref":"","in":"query","required":false,"desc":"The date order in which to return results","default":"desc","type":"string","name":"order"}],"url":"/courses"},"isReference":true,"order":1,"body":"The **Course Listings** method returns a filterable list of basic course objects matching the search criteria. The result is paginated according to the **per_page** parameter which defaults to 10 and may return up to 100 records at a time.\n\nMost parameters take a pipe delimited list of values to include multiple sections.The course **language** must be in the following list:\n\n* English\n* Spanish\n* French\n* Chinese\n* Portuguese\n* Arabic\n* Other\n\nThe **order** parameter allows courses to be returned in either descending order (latest courses first)  or ascending order (oldest courses first) by using values of asc or desc.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Courses are also searchable via the Search API\",\n  \"body\": \"\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\nLists all courses in Europe in 2015.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: YOUR_APP_KEY\\\" https://api.triathlon.org/v1/courses?region_id=10&start_date=2015-01-01&end_date=2016-01-01\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nLists all Level 1 and Level 2 Technical Officials courses held in Spanish.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: YOUR_APP_KEY\\\" https://api.triathlon.org/v1/courses?category_id=239|252&language=Spanish\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"courses-listings","type":"endpoint","title":"Course Listings"}

getCourse Listings


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

per_page:
integer10
How many courses to be returned per page
page:
integer
The page number to be returned
category_id:
string
A pipe delimited list of category ids
name:
string
Restrict returned courses by name
start_date:
string
The earliest date for courses to be returned
end_date:
string
The latest date for courses to be returned
region_id:
string
A pipe delimited list of region ids
country_id:
string
A pipe delimited list of country ids
course_id:
string
A pipe delimited list of course ids
language:
string
The language of the course
order:
stringdesc
The date order in which to return results

Result Format


Documentation

The **Course Listings** method returns a filterable list of basic course objects matching the search criteria. The result is paginated according to the **per_page** parameter which defaults to 10 and may return up to 100 records at a time. Most parameters take a pipe delimited list of values to include multiple sections.The course **language** must be in the following list: * English * Spanish * French * Chinese * Portuguese * Arabic * Other The **order** parameter allows courses to be returned in either descending order (latest courses first) or ascending order (oldest courses first) by using values of asc or desc. [block:callout] { "type": "warning", "title": "Courses are also searchable via the Search API", "body": "" } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] Lists all courses in Europe in 2015. [block:code] { "codes": [ { "code": "curl --header \"apikey: YOUR_APP_KEY\" https://api.triathlon.org/v1/courses?region_id=10&start_date=2015-01-01&end_date=2016-01-01", "language": "curl" } ] } [/block] Lists all Level 1 and Level 2 Technical Officials courses held in Spanish. [block:code] { "codes": [ { "code": "curl --header \"apikey: YOUR_APP_KEY\" https://api.triathlon.org/v1/courses?category_id=239|252&language=Spanish", "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 }}