Sign in

Post API v1 survey

Changed on
post/api/v1/survey/

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

$schemastring uri

A URL to the JSON Schema for this object.

academic_career_resourcesinteger required

Academic/career resources rating (1–5)

academics_athletics_priorityinteger required

Academics vs athletics priority rating (1–5)

college_idstring required

ID of the college being rated

cultureinteger required

Culture rating (1–5)

environmentinteger required

Environment rating (1–5)

mental_health_priorityinteger required

Mental health priority rating (1–5)

player_devinteger required

Player development rating (1–5)

program_gender'mens' | 'womens' required

Whether the rated program is the men's or women's team

sport_idstring required

ID of the sport program being rated

transparencyinteger required

Transparency rating (1–5)

user_idstring required

ID of the user submitting the survey

Example request

{
  "$schema": "https://example.com/schemas/CreateSurveyRequest.json",
  "academic_career_resources": 4,
  "academics_athletics_priority": 3,
  "culture": 4,
  "environment": 5,
  "mental_health_priority": 3,
  "player_dev": 4,
  "program_gender": "womens",
  "transparency": 3
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

academic_career_resourcesinteger required

Academic/career resources rating

academics_athletics_priorityinteger required

Academics vs athletics priority rating

college_idstring required

College ID

cultureinteger required

Culture rating

environmentinteger required

Environment rating

idstring required

Survey ID

mental_health_priorityinteger required

Mental health priority rating

player_devinteger required

Player development rating

program_gender'mens' | 'womens' required

Program gender (mens or womens)

sport_idstring required

Sport ID

transparencyinteger required

Transparency rating

user_idstring required

User ID

Example response

{
  "$schema": "https://example.com/schemas/SurveyResponse.json"
}

Changes