Get the volunteer questions for a race.
Each question has the following fields:
question_id - Question IDquestion - Question textquestion_type - Question type as human readable stringquestion_type_code - Question type code:
validation_type:
none: No validation.phone: Validation for a phone number.char_limit: Response cannot exceed the set character limit.email: Validation for an email address.float: Validates a floating point decimal number.uint: Validates an unsigned integer.int: Validates a signed integer.date: Validates a date.allowed_values: Ensures the response is found in a set of allowed responses.url: Validation for a URL.deleted - T/Frequired - T/Ftask_specific - T/Finternal_question - T/F
{
"questions": [
{
"question_id": 15,
"question": "Do you like cats?",
"question_type": "B",
"validation_type": "none",
"deleted": "F",
"required": "F",
"task_specific": "F",
"internal_question": "F"
},
{
"question_id": 16,
"question": "What is your shirt size?",
"question_type": "R",
"validation_type": "none",
"deleted": "F",
"required": "T"
"task_specific": "F",
"internal_question": "F"
},
{
"question_id": 17,
"question": "Which of these colors do you enjoy?",
"question_type": "C",
"validation_type": "none",
"deleted": "F",
"required": "T"
"task_specific": "F",
"internal_question": "F",
"responses": [
{
"response_id": 24,
"question_id": 19,
"response": "Red",
"deleted": "F"
},
{
"response_id": 25,
"question_id": 19,
"response": "Green",
"deleted": "F"
},
{
"response_id": 26,
"question_id": 19,
"response": "Blue",
"deleted": "F"
},
{
"response_id": 27,
"question_id": 19,
"response": "Yellow",
"deleted": "F"
}
]
},
]
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
race_idRequired |
GET | Race ID. | uint |
|
include_deleted_questions |
GET | F | Should deleted questions be included? | bool |
include_deleted_canned_responses |
GET | F | Should deleted canned responses be included? | bool |
api_key |
GET | API key. | string |
|
api_secret |
GET | API secret. | string |
{
"openapi": "3.0.3",
"info": {
"title": "Get Race Volunteer Questions",
"description": "Get volunteer questions for a race.",
"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": "Volunteers",
"description": "APIs related to Volunteers"
}
],
"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": {
"/v2/volunteers/get-race-volunteer-questions.json": {
"get": {
"tags": [
"Volunteers"
],
"summary": "Get Race Volunteer Questions",
"description": "Get volunteer questions for a race.",
"operationId": "v2_volunteers_get_race_volunteer_questions_json",
"parameters": [
{
"name": "race_id",
"in": "query",
"description": "Race ID.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "include_deleted_questions",
"in": "query",
"description": "Should deleted questions be included?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_deleted_canned_responses",
"in": "query",
"description": "Should deleted canned responses be included?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "checkin_api_key",
"in": "query",
"description": "Checkin API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-CHECKIN-API-SECRET",
"in": "header",
"description": "Checkin API secret.",
"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"
}
}
],
"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"
]
}
}
}
}
