This API retrieves all the non-standard scoring types for a given race_series_year_id
.
Note: This endpoint only allows OAuth 2.0 authentication and requires the user to be a director of the race series. It is currently in beta and subject to change.
{ "non_standard_scoring_types": [ { "scoring_type_id": 5, "scoring_type_name": "Custom Name One" }, { "scoring_type_id": 6, "scoring_type_name": "Custom Name Two" }, { "scoring_type_id": 7, "scoring_type_name": "Custom Name Three" } ] }
Parameter | HTTP Method | Default | Description | Datatype |
---|---|---|---|---|
Authorization Required |
HTTP Header | OAuth 2.0 Authorization header (e.g. `Bearer ...`). | string |
|
race_series_id Required |
GET | Race series ID. | uint |
|
race_series_year_id Required |
GET | Race series year ID. | uint |
{ "openapi": "3.0.3", "info": { "title": "Get Non Standard Scoring Types (BETA)", "description": "Get 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://runsignup.com/API", "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" } }, "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": { "/v2/race-series/non-standard-scoring-types.json": { "get": { "tags": [ "Race Series Scoring" ], "summary": "Get Non Standard Scoring Types (BETA)", "description": "Get non-standard scoring types.", "operationId": "v2_race_series_non_standard_scoring_types_json", "parameters": [ { "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" ] } } } }