Set up splits for a result set. The splits posted will completely replace existing splits. You can specify a 'split_id' with each split to indicate that an existing split should be edited. The splits should be listed in the order they should be displayed in.
The 'pace_type' field can be:
The 'approx_percent_time_complete' field indicates the approximate percent of the race that has been completed in terms of time. This can be used with result notifications to estimate finishing times. For running races, this is typically the percent of the distance completed. For example, the 5 mile split in a 10 mile race would be 50%. For triathlons, you can leave it blank or use average times for each segment of the race to pick a percentage.
For JSON, the request should look like the example below.
{
"result_set_splits": [
{
"split_id": null,
"split_name": "3 Mile",
"split_distance": 3,
"split_distance_units": "M",
"pace_type": "T",
"approx_percent_time_complete": 30,
"include_split_place": "F"
},
{
"split_id": null,
"split_name": "5 Mile",
"split_distance": 5,
"split_distance_units": "M",
"pace_type": "T",
"approx_percent_time_complete": 50,
"include_split_place": "F"
},
{
"split_id": null,
"split_name": "7 Mile",
"split_distance": 7,
"split_distance_units": "M",
"pace_type": "T",
"approx_percent_time_complete": 70,
"include_split_place": "F"
}
]
}
For XML, the request should look like the example below.
<?xml version="1.0" encoding="utf-8" ?> <result_set_splits> <result_set_split> <split_id></split_id> <split_name>3 Mile</split_name> <split_distance>3</split_distance> <split_distance_units>M</split_distance_units> <pace_type>T</pace_type> <approx_percent_time_complete>30</approx_percent_time_complete> <include_split_place>F</include_split_place> </result_set_split> <result_set_split> <split_id></split_id> <split_name>5 Mile</split_name> <split_distance>5</split_distance> <split_distance_units>M</split_distance_units> <pace_type>T</pace_type> <approx_percent_time_complete>50</approx_percent_time_complete> <include_split_place>F</include_split_place> </result_set_split> <result_set_split> <split_id></split_id> <split_name>7 Mile</split_name> <split_distance>7</split_distance> <split_distance_units>M</split_distance_units> <pace_type>T</pace_type> <approx_percent_time_complete>70</approx_percent_time_complete> <include_split_place>F</include_split_place> </result_set_split> </result_set_splits>
For CSV, the request should look like the example below.
split_id,split_name,split_distance,split_distance_units,pace_type,approx_percent_time_complete,include_split_place ,"3 Mile",3,M,T,30,F ,"5 Mile",5,M,T,50,F ,"7 Mile",7,M,T,70,F
| 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 |
POST | ID of race. | uint |
|
event_idRequired |
POST | ID of event. | uint |
|
individual_result_set_id |
POST | ID of result set. | 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": "Setup Splits for Result Sets",
"description": "Setup splits 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://runsignup.com/API",
"description": "Production API Server"
}
],
"tags": [
{
"name": "Results - Splits",
"description": "APIs related to Results - Splits"
}
],
"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/results/result-set-splits": {
"post": {
"tags": [
"Results - Splits"
],
"summary": "Setup Splits for Result Sets",
"description": "Setup splits for a result set.",
"operationId": "race_:race_id_results_result_set_splits",
"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.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "individual_result_set_id",
"in": "query",
"description": "ID of result set.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "request_format",
"in": "query",
"description": "Format of request. The default if not sent is `xml`, but `json` is preferred.",
"required": false,
"schema": {
"type": "string",
"enum": [
"xml",
"json",
"csv"
],
"default": "xml"
}
},
{
"name": "request",
"in": "query",
"description": "Request in proper format.",
"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": [
"partners",
"race_directors",
"timers"
]
}
}
}
}
