Manage race group/team types. This API does not support all settings available through the UI. If a race has already set up group/team types through the UI, be careful with modifying them via this API. To edit a group/team type, include the team_type_id field with the group type information. Any existing group/team type not included in the request will be deleted. Returns group/team type IDs in the order specified.
For JSON requests, the request should look like the example below.
{
"race_team_types": [
{
"team_type_id": 1123,
"team_type": "Competitive Team",
"team_type_desc": "Competitive Team Description",
"min_members": 0,
"max_members": null,
"min_male_members": 1,
"max_male_members": null,
"min_female_members": 1,
"max_female_members": null,
"max_num_teams": null,
"valid_event_ids": [11428, 11429],
"require_gender_selection": "T",
"allow_all_male_team": "T",
"allow_all_female_team": "T",
"allow_coed_team": "F",
"allow_nonbinary_in_male_or_female": "F"
}
]
}
For XML requests, the request should look like the example below.
<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> </race_team_type> </race_team_types>
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
api_key |
GET | API Key | string |
|
api_secret |
GET | 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 |
|
Authorization |
HTTP Header | Authorization Header. If using OAuth 2.0, fill this in with `Bearer <token>`. | 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 |
POST | ID of race. | uint |
|
race_event_days_idRequired |
POST | 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 |
|
request_format |
POST | xml | Format of request. The default if not sent is `xml`, but `json` is preferred. | format |
requestRequired |
POST | Request in proper format. | string |
{
"openapi": "3.0.3",
"info": {
"title": "Manage Race Group/Team Types",
"description": "Manage 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://api.runsignup.com/rest",
"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"
},
"details": {
"type": "object",
"description": "Additional error details",
"additionalProperties": true
}
},
"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": {
"post": {
"tags": [
"Race Groups/Teams"
],
"summary": "Manage Race Group/Team Types",
"description": "Manage race group/team types.",
"operationId": "race_:race_id_teams_team_types",
"parameters": [
{
"name": "race_id",
"in": "path",
"description": "Path parameter: race_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"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": "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": "Authorization",
"in": "header",
"description": "Authorization Header. If using OAuth 2.0, fill this in with `Bearer <token>`.",
"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_event_days_id",
"in": "query",
"description": "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.",
"required": true,
"schema": {
"type": "integer"
}
}
],
"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"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"request_format": {
"type": "string",
"enum": [
"xml",
"json",
"csv"
],
"default": "xml"
},
"request": {
"type": "string"
}
},
"required": [
"request"
]
}
}
}
}
}
}
}
}
