Get information on race corrals.
An XML response will look similar to this example:
<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE race_corrals SYSTEM "https://runsignup.com/rest/rsu.dtd"> <race_corrals> <race_corral> <race_corral_id>40</race_corral_id> <race_corral_name>Corral 1</race_corral_name> <race_corral_start_desc>+0 Minutes</race_corral_start_desc> <race_corral_desc></race_corral_desc> <race_corral_applicable_event_ids> <event_id>123</event_id> <event_id>124</event_id> <event_id>125</event_id> </race_corral_applicable_event_ids> </race_corral> <race_corral> <race_corral_id>41</race_corral_id> <race_corral_name>Corral 2</race_corral_name> <race_corral_start_desc>+4 Minutes</race_corral_start_desc> <race_corral_desc></race_corral_desc> <race_corral_applicable_event_ids> <event_id>123</event_id> <event_id>124</event_id> </race_corral_applicable_event_ids> </race_corral> </race_corrals>
A JSON response will look similar to this example:
{ "race_corrals": [ { "race_corral_id": 40, "race_corral_name": "Corral 1", "race_corral_start_desc": "+0 Minutes", "race_corral_desc": null, "race_corral_applicable_event_ids": [ 123, 124, 125 ] }, { "race_corral_id": 41, "race_corral_name": "Corral 2", "race_corral_start_desc": "+4 Minutes", "race_corral_desc": null, "race_corral_applicable_event_ids": [ 123, 124 ] } ] }
Parameter | HTTP Method | Default | Description | Datatype |
---|---|---|---|---|
api_key |
GET | API Key | string |
|
api_secret |
GET | API Secret | string |
|
tmp_key |
GET | Temporary API Key from login API call. This should NOT be used in combination with API Key. | string |
|
tmp_secret |
GET | Temporary API Secret from login API call. This should NOT be used in combination with API Secret. | string |
|
rsu_api_key |
GET | API v2 key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. | string |
|
sp_api_key |
GET | Super partner API key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. | string |
|
X-RSU-API-SECRET |
HTTP Header | API v2 or super partner secret. | string |
|
format |
GET | xml | Format of response. The default if not sent is `xml`, but `json` is preferred. | format |
Parameter | HTTP Method | Default | Description | Datatype |
---|---|---|---|---|
race_id Required |
GET | ID of race. | uint |
|
race_event_days_id Required |
GET | Race event days ID. This ID groups together events, typically by year. This ID is returned with the event information in the APIs to get races or a single race. | uint |