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 AIs

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

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
Example:
1
Query Params
username
string 
optional
Example:
admin
limit
integer 
required
offset
integer 
optional
Header Params
Authorization
string 
optional
Example:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE3MDM3MzM1NjQsImlzcyI6Imp3dCJ9.Xo_0epX1XR_SQ8_kPsEDNzUJ4Jyuns0cTdSJJQiaG8o

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/1/ais?username=admin&limit=&offset=' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE3MDM3MzM1NjQsImlzcyI6Imp3dCJ9.Xo_0epX1XR_SQ8_kPsEDNzUJ4Jyuns0cTdSJJQiaG8o'

Responses

🟢200OK
application/json
Body
count
integer 
required
data
array [object {6}] 
required
id
integer 
required
sdk
object (sdk_base) 
required
note
string 
required
edited by the contestant
status
object 
required
user
object (user_base) 
required
time
string 
required
Example
{
    "count": 0,
    "data": [
        {
            "id": 0,
            "sdk": {
                "id": 0,
                "name": "string"
            },
            "note": "string",
            "status": {
                "state": "pending"
            },
            "user": {
                "avatar_url": "string",
                "nickname": "string",
                "username": "string"
            },
            "time": "string"
        }
    ]
}
Previous
get the game
Next
commit an AI
Built with