{"__v":2,"_id":"564b7ceecc472d0d00da9440","category":{"__v":31,"_id":"55773ac207e7110d001043ed","pages":["55776bbce6063e0d00481401","564b7a4e1ed5c823003eb64b","564b7c0fdda79a19000f2653","564b7c2385e4e92b00fb4f8a","564b7c2edda79a19000f2656","564b7c394f06ef2b006b08a5","564b7c6b85e4e92b00fb4f8c","564b7c791ed5c823003eb64f","564b7c83cc472d0d00da943d","564b7c8f766d4923004e1fbc","564b7ca385e4e92b00fb4f8f","564b7cb21ed5c823003eb654","564b7ccb766d4923004e1fbf","564b7cdf766d4923004e1fc1","564b7ceecc472d0d00da9440","564b7d014f06ef2b006b08a8","564b7d201ed5c823003eb656","564b7d2ee323d01700a51340","564b7d3b1ed5c823003eb658","564b7d4be323d01700a51344","564b7d5ee323d01700a51346","564b7d73cc472d0d00da9442","564b7d8adda79a19000f265a","564b7e0b85e4e92b00fb4f92","564b7e1be323d01700a51348","564b7e2b1ed5c823003eb65a","564b7e3f766d4923004e1fc4","564b7e4fdda79a19000f265c","564b7e5a766d4923004e1fc6","56eb12a90e62750e0060d027","56f184bf3af4942b00bb3c33"],"project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-09T19:13:06.237Z","from_sync":false,"order":3,"slug":"events-api","title":"Events 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:15:58.016Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"code\": 200,\n    \"status\": \"success\",\n    \"data\": [\n        {\n            \"prog_id\": 281143,\n            \"event_id\": 97641,\n            \"prog_name\": \"Elite Coaches\",\n            \"prog_date\": \"2016-06-12\",\n            \"prog_time\": \"00:00:00\",\n            \"prog_notes\": null,\n            \"results\": false,\n            \"team\": false\n        },\n        {\n            \"prog_id\": 281144,\n            \"event_id\": 97641,\n            \"prog_name\": \"Elite Men\",\n            \"prog_date\": \"2016-06-12\",\n            \"prog_time\": \"00:00:00\",\n            \"prog_notes\": \"Technical Delegate: Stefane Mauris/SUI. Race Referee Sarah Taylor/GBR. Competition Jury: Stegfane Mauris/SUI, Terry Sheldrake/NZL, Helen Wyeth/GBR.\\nDistances: Swin 1500 m (2 laps), Bike 41.765 km (13.8 km + 7 laps of 3.95 km) Run 10 km (4 laps)\\nWater temperature 18.2ºC, Air temperature 18.2º C. Wetsuit swim.\",\n            \"results\": true,\n            \"team\": false\n        },\n        {\n            \"prog_id\": 281145,\n            \"event_id\": 97641,\n            \"prog_name\": \"Elite Women\",\n            \"prog_date\": \"2016-06-12\",\n            \"prog_time\": \"00:00:00\",\n            \"prog_notes\": \"Technical Delegate: Stefane Mauris/SUI. Race Referee Howard Vine/GBR. Competition Jury: Stegfane Mauris/SUI, Terry Sheldrake/NZL, Helen Wyeth/GBR.\\nDistances: Swin 1500 m (2 laps), Bike 41.765 km (13.8 km + 7 laps of 3.95 km) Run 10 km ($ laps)\\nWater temperature 18.5ºC, Air temperature 18.9º C. Wetsuit swim.\",\n            \"results\": true,\n            \"team\": false\n        }\n    ]\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5658b34cdd08bf17009ec474","ref":"","in":"path","required":true,"desc":"The unique id of the event","default":"","type":"int","name":"event_id"},{"_id":"5720f4472ef7950e00fe6f71","ref":"","in":"query","required":false,"desc":"A prog name to perform a fuzzy filter on","default":"","type":"string","name":"prog_name"},{"_id":"5720f4472ef7950e00fe6f70","ref":"","in":"query","required":false,"desc":"A pipe delimited list of programs to restrict programs to","default":"","type":"string","name":"prog_filter"},{"_id":"5720f4472ef7950e00fe6f6f","ref":"","in":"query","required":false,"desc":"A pipe delimited list of programs to exclude from the results","default":"","type":"string","name":"exclude"},{"_id":"5720f4472ef7950e00fe6f6e","ref":"","in":"query","required":false,"desc":"A pipe delimited list of prog_ids to be returned","default":"","type":"string","name":"prog_id"}],"url":"/events/:event_id/programs"},"isReference":true,"order":14,"body":"The **Program Listings** method returns an array of basic program objects for an **event id**.\n\nThe `results` boolean indicates whether results are available for this program. If so you should consult the [Program Results](https://developers.triathlon.org/docs/program-results) method to return them.\n\nThe `team` boolean indicates whether this program is a team program and as such will return team entries and team results where relevant.\n\nThe `prog_notes` are provided where available and give additional information and context as to the exact specifications of the program. Some of this information is extracted and also provided as headers in the **Retrieve Program Information** and **Program Results** methods.\n\nThe following example retrieves the full program listings from event_id of 90162. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: [[app:key]]\\\" https://api.triathlon.org/v1/events/90162/programs\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"program-listings","type":"endpoint","title":"Program Listings"}

getProgram Listings


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

event_id:
required
integer
The unique id of the event

Query Params

prog_name:
string
A prog name to perform a fuzzy filter on
prog_filter:
string
A pipe delimited list of programs to restrict programs to
exclude:
string
A pipe delimited list of programs to exclude from the results
prog_id:
string
A pipe delimited list of prog_ids to be returned

Result Format


Documentation

The **Program Listings** method returns an array of basic program objects for an **event id**. The `results` boolean indicates whether results are available for this program. If so you should consult the [Program Results](https://developers.triathlon.org/docs/program-results) method to return them. The `team` boolean indicates whether this program is a team program and as such will return team entries and team results where relevant. The `prog_notes` are provided where available and give additional information and context as to the exact specifications of the program. Some of this information is extracted and also provided as headers in the **Retrieve Program Information** and **Program Results** methods. The following example retrieves the full program listings from event_id of 90162. [block:code] { "codes": [ { "code": "curl --header \"apikey: [[app:key]]\" https://api.triathlon.org/v1/events/90162/programs", "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 }}