{"_id":"59cd57739d0a130010f20e24","project":"55773a5ba042551900b002cb","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":"59cd4b81935249001c77c48e","project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-28T19:20:33.950Z","from_sync":false,"order":14,"slug":"officials-api","title":"Officials API"},"user":"546d17e2eb9cfd1400dd4529","__v":10,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-28T20:11:31.569Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n   \"code\":200,\n   \"status\":\"success\",\n   \"total\":9999,\n   \"per_page\":\"1\",\n   \"current_page\":1,\n   \"last_page\":9999,\n   \"next_page_url\":\"https://api.triathlon.org/v1/officials?per_page=1&page=2\",\n   \"prev_page_url\":null,\n   \"from\":1,\n   \"to\":1,\n   \"data\":[\n      {\n         \"official_id\":123456,\n         \"official_title\":\"Technical Official\",\n         \"official_first\":\"Technical\",\n         \"official_last\":\"Official\",\n         \"official_gender\":\"female\",\n         \"official_noc\":\"GRE\",\n         \"official_year_of_birth\":1990,\n         \"official_certificate_year\":2008,\n         \"official_level\":3,\n         \"official_itu_id\":654321,\n         \"official_slug\":\"technical_official\",\n         \"official_country_id\":172,\n         \"official_country_name\":\"Greece\",\n         \"official_country_isoa2\":\"GR\",\n         \"official_region_id\":10,\n         \"official_region\":\"ETU\",\n         \"official_region_name\":\"Europe\",\n         \"official_flag\":\"https://f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com/images/icons/gr.png\",\n         \"official_api_listing\":\"https://api.triathlon.org/v1/officials/123456\",\n         \"official_valid_date\":2019\n      }\n   ]\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"59cd57739d0a130010f20e2e","ref":"","in":"query","required":false,"desc":"How many officials to be returned per page","default":"10","type":"int","name":"per_page"},{"_id":"59cd57739d0a130010f20e2d","ref":"","in":"query","required":false,"desc":"The page number to be returned","default":"","type":"int","name":"page"},{"_id":"59cd57739d0a130010f20e2c","ref":"","in":"query","required":false,"desc":"Restrict returned officials by name","default":"","type":"string","name":"name"},{"_id":"59cd57739d0a130010f20e2b","ref":"","in":"query","required":false,"desc":"A pipe delimited list of country ids","default":"","type":"string","name":"country_id"},{"_id":"59cd57739d0a130010f20e2a","ref":"","in":"query","required":false,"desc":"A pipe delimited list of region ids","default":"","type":"string","name":"region_id"},{"_id":"59cd57739d0a130010f20e29","ref":"","in":"query","required":false,"desc":"Restrict returned athletes by gender (male|female)","default":"","type":"string","name":"gender"},{"_id":"59cd57739d0a130010f20e28","ref":"","in":"query","required":false,"desc":"A pipe delimited list of official ids","default":"","type":"string","name":"official__id"},{"_id":"59cd57739d0a130010f20e27","ref":"","in":"query","required":false,"desc":"A pipe delimited list of years that TO accreditation is valid to","default":"","type":"string","name":"valid_year"},{"_id":"59cd57739d0a130010f20e26","ref":"","in":"query","required":false,"desc":"A pipe delimited list of levels to filter the results","default":"","type":"string","name":"level"},{"_id":"59cd57739d0a130010f20e25","ref":"","in":"query","required":false,"desc":"A pipe delimited list of certificate years","default":"","type":"string","name":"certificate_year"}],"url":"/officials"},"isReference":false,"order":999,"body":"The **Officials Listings** method returns a filterable list of basic official objects matching the search criteria.\n\nValues for `country_id` and `region_id` may be obtained from the [Federation API endpoints](https://developers.triathlon.org/docs/federation-api-overview) [Country Listings](https://developers.triathlon.org/docs/country-listings) and [Region Listings](https://developers.triathlon.org/docs/region-listings) respectively. For both parameters, a pipe-delimited list of ids may be passed to restrict results by multiple countries/regions.\n\nThe `name` parameter allows a fuzzy search by both first name or last name.\n\nThe following example retrieves all level 3 officials from Greece:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: YOUR_APP_KEY\\\" https://api.triathlon.org/v1/officials?country_id=293&level=3\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"officials-listings","type":"endpoint","title":"Officials Listings"}

getOfficials Listings


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

per_page:
integer10
How many officials to be returned per page
page:
integer
The page number to be returned
name:
string
Restrict returned officials by name
country_id:
string
A pipe delimited list of country ids
region_id:
string
A pipe delimited list of region ids
gender:
string
Restrict returned athletes by gender (male|female)
official__id:
string
A pipe delimited list of official ids
valid_year:
string
A pipe delimited list of years that TO accreditation is valid to
level:
string
A pipe delimited list of levels to filter the results
certificate_year:
string
A pipe delimited list of certificate years

Result Format


Documentation

The **Officials Listings** method returns a filterable list of basic official objects matching the search criteria. Values for `country_id` and `region_id` may be obtained from the [Federation API endpoints](https://developers.triathlon.org/docs/federation-api-overview) [Country Listings](https://developers.triathlon.org/docs/country-listings) and [Region Listings](https://developers.triathlon.org/docs/region-listings) respectively. For both parameters, a pipe-delimited list of ids may be passed to restrict results by multiple countries/regions. The `name` parameter allows a fuzzy search by both first name or last name. The following example retrieves all level 3 officials from Greece: [block:code] { "codes": [ { "code": "curl --header \"apikey: YOUR_APP_KEY\" https://api.triathlon.org/v1/officials?country_id=293&level=3", "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 }}