hiper-backend
  1. base contest
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
      • update the registration password
    • get contests
      GET
    • register for contest
      PUT
    • exit contest
      DELETE
  • permission
    • grant creation permission
    • revoke creation permission
  • 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. base contest

get contestants

Developing
GET
/games/{id}/contestants
By default: ?sort=-points

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 '/games//contestants'

Responses

🟢200OK
application/json
Body
array of:
assigned_ai
object (ai) 
required
id
integer 
required
sdk
object (sdk_base) 
required
note
string 
required
edited by the contestant
status
object 
required
user
object (user_base) 
required
performance
string 
required
赛事脚本编辑。可在排行榜中展示
permissions
object 
required
assign_ai_enabled
boolean 
required
public_match_enabled
boolean 
required
points
integer 
required
积分
user
object (user) 
required
avatar_url
string 
required
nickname
string 
required
username
string 
required
bio
string 
optional
department
string 
optional
name
string 
optional
permissions
object 
required
global
school
string 
optional
Example
[
    {
        "assigned_ai": {
            "id": 0,
            "sdk": {
                "id": 0,
                "name": "string"
            },
            "note": "string",
            "status": {
                "state": "pending"
            },
            "user": {
                "avatar_url": "string",
                "nickname": "string",
                "username": "string"
            }
        },
        "performance": "string",
        "permissions": {
            "assign_ai_enabled": true,
            "public_match_enabled": true
        },
        "points": 0,
        "user": {
            "avatar_url": "string",
            "nickname": "string",
            "username": "string",
            "bio": "string",
            "department": "string",
            "name": "string",
            "permissions": {
                "can_create_game_or_contest": "true"
            },
            "school": "string"
        }
    }
]
Previous
edit ai note
Next
assign an AI
Built with