{"_id":"59f0d025d9106d001a272d9c","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":8,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-25T17:55:49.656Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"code\": 200,\n    \"status\": \"success\",\n    \"total\": 5,\n    \"per_page\": \"1\",\n    \"current_page\": 1,\n    \"last_page\": 5,\n    \"next_page_url\": \"https://api.triathlon.org/v1/officials/assignments?per_page=1&page=2\",\n    \"prev_page_url\": null,\n    \"from\": 1,\n    \"to\": 1,\n    \"data\": [\n        {\n            \"official_id\": 4388,\n            \"assignment_id\": 31862,\n            \"assignment_venue\": \"Sokcho\",\n            \"event_type\": \"Triathlon\",\n            \"event_category\": \"Continental Cup\",\n            \"region\": \"Asia\",\n            \"position\": \"Chief Vehicular\",\n            \"event_date\": \"2017-07-01\",\n            \"event_id\": 1249,\n            \"successfuly_att\": \"5\",\n            \"evaluated_loc\": null,\n            \"event\": []\n        }\n    ]\n}","name":""}]},"examples":{"codes":[]},"method":"get","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":"59cd57739d0a130010f20e28","ref":"","in":"query","required":false,"desc":"A pipe delimited list of official ids","default":"","type":"string","name":"official__id"},{"_id":"59f0d025d9106d001a272d9d","ref":"","in":"query","required":false,"desc":"A pipe delimited list of assignments","default":"","type":"string","name":"position"},{"_id":"5a033fff9deaaa001cd6fa18","ref":"","in":"query","required":false,"desc":"The start date to limit results","default":"","type":"yyyy-mm-dd","name":"start_date"},{"_id":"5a033fff9deaaa001cd6fa17","ref":"","in":"query","required":false,"desc":"The end date to limit results","default":"","type":"yyyy-mm-dd","name":"end_date"}],"url":"/officials/assignments"},"isReference":false,"order":12,"body":"The **Officials Assignments Listings** method provides a filterable listing of assignments. Assignments may be filtered on `position` which correspond to the [Officials Positions](https://developers.triathlon.org/docs/officials-positions) method or by `official_id` and `start_date` and `end_date`. \n\nFor example to find the all the 2017 assignments relating to the `Chielf Vehicular` position the following API call may be used:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: [[app:key]]\\\" https://api.triathlon.org/v1/officials/assignments?position=Chief%20Vehicular&start_date=2017-01-01&end_date=2018-01-01\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"officials-assignments-listings","type":"endpoint","title":"Officials Assignments Listings"}

getOfficials Assignments 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
official__id:
string
A pipe delimited list of official ids
position:
string
A pipe delimited list of assignments
start_date:
yyyy-mm-dd
The start date to limit results
end_date:
yyyy-mm-dd
The end date to limit results

Result Format


Documentation

The **Officials Assignments Listings** method provides a filterable listing of assignments. Assignments may be filtered on `position` which correspond to the [Officials Positions](https://developers.triathlon.org/docs/officials-positions) method or by `official_id` and `start_date` and `end_date`. For example to find the all the 2017 assignments relating to the `Chielf Vehicular` position the following API call may be used: [block:code] { "codes": [ { "code": "curl --header \"apikey: [[app:key]]\" https://api.triathlon.org/v1/officials/assignments?position=Chief%20Vehicular&start_date=2017-01-01&end_date=2018-01-01", "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 }}