Get the YouTube finish line video and split video settings for a result set.
Each video has a list of offsets that map a range of clock times to a time in the video.
A clock_time_end_sec of null means the range has no end.
Every split in the result set is returned in split_videos.
Splits without a video have a null video_id and play_start_padding_sec and an empty offsets list.
{
"finish_line_video": {
"video_id": "itpHfrH0pFg",
"play_start_padding_sec": 5,
"offsets": [
{
"clock_time_start_sec": 3900,
"clock_time_end_sec": 4505,
"video_offset_sec": 10
},
{
"clock_time_start_sec": 4505,
"clock_time_end_sec": null,
"video_offset_sec": 900
}
]
},
"split_videos": [
{
"split_id": 12345,
"split_name": "Halfway",
"video_id": "dQw4w9WgXcQ",
"play_start_padding_sec": 5,
"offsets": [
{
"clock_time_start_sec": 1800,
"clock_time_end_sec": 2400,
"video_offset_sec": 5
}
]
},
{
"split_id": 12346,
"split_name": "Mile 10",
"video_id": null,
"play_start_padding_sec": null,
"offsets": []
}
]
}
| 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 |
|---|---|---|---|---|
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 |
GET | ID of race. | uint |
|
event_idRequired |
GET | ID of the event. | uint |
|
individual_result_set_idRequired |
GET | ID of the result set. | uint |
{
"openapi": "3.0.3",
"info": {
"title": "Get Video Settings for Result Sets",
"description": "Get finish line and split video settings for a result set.",
"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": "Results - Videos",
"description": "APIs related to Results - Videos"
}
],
"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"
}
]
},
"V2ResultsResultSetVideoSettingsGetResponse": {
"type": "object",
"title": "Result Set Video Settings Response",
"description": "Finish line and split video settings for a result set.",
"properties": {
"finish_line_video": {
"type": "object",
"description": "Finish line video settings. Null when there is no finish line video",
"nullable": true,
"properties": {
"video_id": {
"type": "string",
"description": "YouTube video ID"
},
"play_start_padding_sec": {
"type": "integer",
"description": "Number of seconds before the finish to start playing the video"
},
"offsets": {
"type": "array",
"description": "Video offsets, sorted by clock_time_start_sec",
"items": {
"type": "object",
"description": "Mapping of a clock time range to a time in the video",
"properties": {
"clock_time_start_sec": {
"type": "integer",
"description": "Clock time at the start of the range, in seconds"
},
"clock_time_end_sec": {
"type": "integer",
"description": "Clock time at the end of the range, in seconds. Null when the range has no end",
"nullable": true
},
"video_offset_sec": {
"type": "integer",
"description": "Time in the video matching clock_time_start_sec, in seconds"
}
},
"required": [
"clock_time_start_sec",
"clock_time_end_sec",
"video_offset_sec"
]
}
}
},
"required": [
"video_id",
"play_start_padding_sec",
"offsets"
]
},
"split_videos": {
"type": "array",
"description": "Video settings for every split in the result set, in split order",
"items": {
"type": "object",
"description": "Video settings for a split",
"properties": {
"split_id": {
"type": "integer",
"description": "ID of the split"
},
"split_name": {
"type": "string",
"description": "Name of the split"
},
"video_id": {
"type": "string",
"description": "YouTube video ID. Null when the split has no video",
"nullable": true
},
"play_start_padding_sec": {
"type": "integer",
"description": "Number of seconds before the split to start playing the video. Null when the split has no video",
"nullable": true
},
"offsets": {
"type": "array",
"description": "Video offsets, sorted by clock_time_start_sec. Empty when the split has no video",
"items": {
"type": "object",
"description": "Mapping of a clock time range to a time in the video",
"properties": {
"clock_time_start_sec": {
"type": "integer",
"description": "Clock time at the start of the range, in seconds"
},
"clock_time_end_sec": {
"type": "integer",
"description": "Clock time at the end of the range, in seconds. Null when the range has no end",
"nullable": true
},
"video_offset_sec": {
"type": "integer",
"description": "Time in the video matching clock_time_start_sec, in seconds"
}
},
"required": [
"clock_time_start_sec",
"clock_time_end_sec",
"video_offset_sec"
]
}
}
},
"required": [
"split_id",
"split_name",
"video_id",
"play_start_padding_sec",
"offsets"
]
}
}
},
"required": [
"finish_line_video",
"split_videos"
],
"example": {
"finish_line_video": {
"video_id": "itpHfrH0pFg",
"play_start_padding_sec": 5,
"offsets": [
{
"clock_time_start_sec": 3900,
"clock_time_end_sec": 4505,
"video_offset_sec": 10
},
{
"clock_time_start_sec": 4505,
"clock_time_end_sec": null,
"video_offset_sec": 900
}
]
},
"split_videos": [
{
"split_id": 12345,
"split_name": "Halfway",
"video_id": "dQw4w9WgXcQ",
"play_start_padding_sec": 5,
"offsets": [
{
"clock_time_start_sec": 1800,
"clock_time_end_sec": 2400,
"video_offset_sec": 5
}
]
},
{
"split_id": 12346,
"split_name": "Mile 10",
"video_id": null,
"play_start_padding_sec": null,
"offsets": []
}
]
}
}
},
"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/results/result-set-video-settings.json": {
"get": {
"tags": [
"Results - Videos"
],
"summary": "Get Video Settings for Result Sets",
"description": "Get finish line and split video settings for a result set.",
"operationId": "v2_results_result_set_video_settings_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": "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_id",
"in": "query",
"description": "ID of race.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "event_id",
"in": "query",
"description": "ID of the event.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "individual_result_set_id",
"in": "query",
"description": "ID of the result set.",
"required": true,
"schema": {
"type": "integer"
}
}
],
"security": [
{
"apiKey": [],
"apiSecret": []
}
],
"responses": {
"200": {
"description": "Result Set Video Settings Response - Finish line and split video settings for a result set.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2ResultsResultSetVideoSettingsGetResponse"
}
}
}
},
"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": [
"partners",
"race_directors",
"timers"
]
}
}
}
}
Log in and register as an API caller to get the most out of the API documentation.
