hiper-backend
  1. administer
hiper-backend
  • API Conventions
  • user
    • before login
      • login
      • register a user
      • request verification code
      • reset email
      • reset password
    • search users
      GET
    • get the user
      GET
    • get current user
      GET
    • update current user
      PATCH
  • game
    • create
      • create a game
    • administer
      • get settings related info about the game
      • update the game's game logic
      • update the game's match detail
    • get games
      GET
  • contest
    • create
      • create a contest
    • administer
      • get settings related info about the contest
        GET
      • update the registration password
        PUT
    • get contests
      GET
    • register for contest
      PUT
    • exit contest
      DELETE
  • permission
    • grant creation permission
      PUT
    • revoke creation permission
      DELETE
  • base contest
    • administer
      • delete the game
      • add admin
      • relinquish admin
      • update contest script
      • update metadata
      • add a sdk
      • get a sdk
      • delete a sdk
      • update a sdk
      • update states
    • get the game
      GET
    • get AIs
      GET
    • commit an AI
      POST
    • get the ai
      GET
    • download the AI
      GET
    • edit ai note
      PUT
    • get contestants
      GET
    • assign an AI
      PUT
    • get current contestant
      GET
    • revoke the assigned AI
      DELETE
    • get matches
      GET
    • get a match
      GET
    • get sdks
      GET
  1. administer

get settings related info about the contest

Designing
GET
/contests/{id}/settings

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params
id
integer 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/contests//settings'

Responses

🟢200OK
application/json
Body
base_contest
object (base_contest_detail_for_admins) 
required
id
integer 
required
game_id
integer 
required
states
object (contest_states) 
required
contest_assets
object 
required
id
integer 
required
my_privilege
enum<string> 
required
Allowed values:
adminregisteredunregistered
metadata
object (metadata) 
required
cover_url
string 
required
readme
string 
required
Markdown
title
string 
required
registration
object 
required
registration_enabled
boolean 
required
password
string 
required
"" means no password.
admins
object (user_base) 
required
avatar_url
string 
required
nickname
string 
required
username
string 
required
Example
{
    "base_contest": {
        "id": 0,
        "game_id": 0,
        "states": {
            "assign_ai_enabled": true,
            "commit_ai_enabled": true,
            "contest_script_environment_enabled": true,
            "private_match_enabled": true,
            "public_match_enabled": true,
            "test_match_enabled": true
        },
        "contest_assets": {
            "contest_script": "string",
            "sdks": [
                {
                    "id": 0,
                    "name": "string",
                    "readme": "string",
                    "build_ai": {
                        "status": "pending"
                    },
                    "run_ai": {
                        "status": "pending"
                    }
                }
            ]
        }
    },
    "id": 0,
    "my_privilege": "admin",
    "metadata": {
        "cover_url": "string",
        "readme": "string",
        "title": "string"
    },
    "registration": {
        "registration_enabled": true,
        "password": "string"
    },
    "admins": {
        "avatar_url": "string",
        "nickname": "string",
        "username": "string"
    }
}
Previous
create a contest
Next
update the registration password
Built with