This API adds non-standard scoring types to a specified race_series_year_id.
Non-standard scoring types with a scoring_type_id will be treated as edits; otherwise, a new scoring type will be added.
If scoring_type_name is omitted from the non_standard_scoring_types, the field will remain unchanged.
Note: This endpoint only allows OAuth 2.0 authentication and requires the user to be a director of the race series or a timer of a race that is included in the series. It is currently in beta and subject to change.
{
"non_standard_scoring_types": [
{
"scoring_type_id": 620,
"scoring_type_name": "Updated Scoring"
},
{
"scoring_type_id": null,
"scoring_type_name": "New Scoring"
}
]
}
{
"added_non_standard_scoring_types": [
{
"scoring_type_id": 621,
"scoring_type_name": "New Scoring"
}
],
"updated_non_standard_scoring_types": [
{
"scoring_type_id": 620,
"scoring_type_name": "Updated Scoring"
}
]
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
rsu_api_reg |
GET | API caller token. If used, you must send the API caller password in an HTTP header named X-RSU-API-REG-SECRET. | string |
|
X-RSU-API-REG-SECRET |
HTTP Header | API caller password. | string |
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
AuthorizationRequired |
HTTP Header | OAuth 2.0 Authorization header (e.g. `Bearer ...`). | string |
|
race_series_idRequired |
GET | Race series ID. | uint |
|
race_series_year_idRequired |
GET | Race series year ID. | uint |
|
requestRequired |
POST | JSON containing a list of non-standard scoring types. | string |
{
"openapi": "3.0.3",
"info": {
"title": "Add/Edit Non Standard Scoring Types (BETA)",
"description": "Add or edit non-standard scoring 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 Series Scoring",
"description": "APIs related to Race Series Scoring"
}
],
"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"
},
"apiCaller": {
"type": "apiKey",
"in": "query",
"name": "rsu_api_reg",
"description": "API caller token (format: <id>.<token>)"
},
"apiCallerSecret": {
"type": "apiKey",
"in": "header",
"name": "X-RSU-API-REG-SECRET",
"description": "API caller password"
}
}
},
"paths": {
"/v2/race-series/non-standard-scoring-types.json": {
"post": {
"tags": [
"Race Series Scoring"
],
"summary": "Add/Edit Non Standard Scoring Types (BETA)",
"description": "Add or edit non-standard scoring types.",
"operationId": "v2_race_series_non_standard_scoring_types_json",
"parameters": [
{
"name": "rsu_api_reg",
"in": "query",
"description": "API caller token. If used, you must send the API caller password in an HTTP header named X-RSU-API-REG-SECRET.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-REG-SECRET",
"in": "header",
"description": "API caller password.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "OAuth 2.0 Authorization header (e.g. `Bearer ...`).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "race_series_id",
"in": "query",
"description": "Race series ID.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "race_series_year_id",
"in": "query",
"description": "Race series year ID.",
"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": [
"race_directors",
"timers"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"request": {
"type": "string"
}
},
"required": [
"request"
]
}
}
}
}
}
}
}
}
Log in and register as an API caller to get the most out of the API documentation.
