Get information on race group/team types. The IDs in the response are required when viewing existing teams/groups and when adding or updating groups/teams.
An XML response will look similar to this example:
<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE events PUBLIC "-//RunSignUp//API" "/rest/rsu.dtd"> <race_team_types> <race_team_type> <team_type_id>1123</team_type_id> <team_type>Competitive Team</team_type> <team_type_desc>Competitive Team Description</team_type_desc> <min_members>0</min_members> <max_members></max_members> <min_male_members>1</min_male_members> <max_male_members></max_male_members> <min_female_members>1</min_female_members> <max_female_members></max_female_members> <max_num_teams></max_num_teams> <valid_event_ids> <event_id>11428</event_id> <event_id>11429</event_id> </valid_event_ids> <require_gender_selection>T</require_gender_selection> <allow_all_male_team>T</allow_all_male_team> <allow_all_female_team>T</allow_all_female_team> <allow_coed_team>F</allow_coed_team> <allow_nonbinary_in_male_or_female>F</allow_nonbinary_in_male_or_female> <require_age_range_selection>F</require_age_range_selection> <team_age_restrictions> <team_age_restriction> <team_age_restriction_id>153</team_age_restriction_id> <min_age>0</min_age> <max_age>10</max_age> </team_age_restriction> <team_age_restriction> <team_age_restriction_id>154</team_age_restriction_id> <min_age>11</min_age> <max_age>15</max_age> </team_age_restriction> <team_age_restriction> <team_age_restriction_id>155</team_age_restriction_id> <min_age>16</min_age> <max_age>19</max_age> </team_age_restriction> <team_age_restriction> <team_age_restriction_id>156</team_age_restriction_id> <min_age>20</min_age> <max_age>29</max_age> </team_age_restriction> <team_age_restriction> <team_age_restriction_id>157</team_age_restriction_id> <min_age>30</min_age> <max_age>39</max_age> </team_age_restriction> <team_age_restriction> <team_age_restriction_id>158</team_age_restriction_id> <min_age>40</min_age> <max_age>49</max_age> </team_age_restriction> <team_age_restriction> <team_age_restriction_id>159</team_age_restriction_id> <min_age>50</min_age> <max_age>59</max_age> </team_age_restriction> <team_age_restriction> <team_age_restriction_id>160</team_age_restriction_id> <min_age>60</min_age> <max_age>69</max_age> </team_age_restriction> <team_age_restriction> <team_age_restriction_id>161</team_age_restriction_id> <min_age>70</min_age> <max_age>999</max_age> </team_age_restriction> </team_age_restrictions> </race_team_type> <race_team_type> <team_type_id>1143</team_type_id> <team_type>Social Team</team_type> <team_type_desc>This is just a simple grouping of friends.</team_type_desc> <min_members>0</min_members> <max_members></max_members> <min_male_members>0</min_male_members> <max_male_members></max_male_members> <min_female_members>0</min_female_members> <max_female_members></max_female_members> <max_num_teams></max_num_teams> <valid_event_ids> <event_id>11428</event_id> <event_id>11429</event_id> <event_id>11430</event_id> </valid_event_ids> <require_gender_selection>F</require_gender_selection> <allow_all_male_team>T</allow_all_male_team> <allow_all_female_team>T</allow_all_female_team> <allow_coed_team>T</allow_coed_team> <allow_nonbinary_in_male_or_female>T</allow_nonbinary_in_male_or_female> <require_age_range_selection>F</require_age_range_selection> <team_age_restrictions></team_age_restrictions> </race_team_type> </race_team_types>
In this response, "require_gender_selection" is "T" or "F" to indicate whether or not gender selection is required when creating a new team. The "require_age_range_selection" field is "T" or "F" to indicate whether or not age range selection is required.
| 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_idRequired |
GET | ID of race. | uint |
|
event_idRequired |
GET | ID of event or list of event IDs separated by commas. | id_list |
{
"openapi": "3.0.3",
"info": {
"title": "Get Race Groups/Teams Types",
"description": "Get race group/team types.",
"version": "1.0.0",
"contact": {
"name": "RunSignup API Support",
"url": "https://runsignup.com/API",
"email": "info@runsignup.com"
}
},
"servers": [
{
"url": "https://runsignup.com/API",
"description": "Production API Server"
}
],
"tags": [
{
"name": "Race Groups/Teams",
"description": "APIs related to Race Groups/Teams"
}
],
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message"
}
},
"required": [
"error"
]
},
"BadRequestError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating invalid request parameters or structure"
}
]
},
"UnauthorizedError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating authentication failure"
}
]
},
"ForbiddenError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the authenticated user lacks required permissions"
}
]
},
"NotFoundError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the requested resource does not exist"
}
]
},
"ServerError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating an unexpected server-side issue"
}
]
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "query",
"name": "api_key",
"description": "RunSignup API Key"
},
"apiSecret": {
"type": "apiKey",
"in": "query",
"name": "api_secret",
"description": "RunSignup API Secret"
}
}
},
"paths": {
"/race/:race_id/teams/team-types": {
"get": {
"tags": [
"Race Groups/Teams"
],
"summary": "Get Race Groups/Teams Types",
"description": "Get race group/team types.",
"operationId": "race_:race_id_teams_team_types",
"parameters": [
{
"name": "api_key",
"in": "query",
"description": "API Key",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "api_secret",
"in": "query",
"description": "API Secret",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tmp_key",
"in": "query",
"description": "Temporary API Key from login API call. This should NOT be used in combination with API Key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tmp_secret",
"in": "query",
"description": "Temporary API Secret from login API call. This should NOT be used in combination with API Secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "rsu_api_key",
"in": "query",
"description": "API v2 key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sp_api_key",
"in": "query",
"description": "Super partner API key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-SECRET",
"in": "header",
"description": "API v2 or super partner secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"description": "Format of response. The default if not sent is `xml`, but `json` is preferred.",
"required": false,
"schema": {
"type": "string",
"enum": [
"xml",
"json",
"csv"
],
"default": "xml"
}
},
{
"name": "race_id",
"in": "query",
"description": "ID of race.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "event_id",
"in": "query",
"description": "ID of event or list of event IDs separated by commas.",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKey": []
},
{
"apiSecret": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerError"
}
}
}
}
},
"x-permissions": [
"affiliates",
"partners",
"race_directors",
"timers"
]
}
}
}
}
