API docs by Redocly

Core (1.0)

Download OpenAPI specification :Download

Authentication

/api/auth

Request Body schema:
firstName
string or null
lastName
string or null
userName
required
string non-empty
password
required
string non-empty
email
string or null
phoneNumber
string or null

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "userName": "string",
  • "password": "string",
  • "email": "string",
  • "phoneNumber": "string"
}

/api/auth/login

Request Body schema:
userName
required
string non-empty
password
required
string non-empty

Responses

Request samples

Content type
{
  • "userName": "string",
  • "password": "string"
}

Leaderboard

GetLeaderboardScores

path Parameters
leaderboardId
required
string <uuid>
query Parameters
ParticipantId
string <uuid>
LeaderboardId
string <uuid>
PageNumber
integer <int32>
PageSize
integer <int32>
OrderBy
string
Fields
string

Responses

GetParticipants

path Parameters
leaderboardId
required
string <uuid>

Responses

Organizations

GetOrganizations

Responses

CreateOrganization

Request Body schema:
name
string or null
address
string or null
country
string or null
Array of objects or null (ParticipantForCreationDto )

Responses

Request samples

Content type
{
  • "name": "string",
  • "address": "string",
  • "country": "string",
  • "participants": [
    ]
}

/api/orgs

Responses

OrgById

path Parameters
id
required
string <uuid>

Responses

/api/orgs/{ id}

path Parameters
id
required
string <uuid>

Responses

OrgCollection

query Parameters
ids
Array of strings <uuid> [ items <uuid > ]

Responses

/api/orgs/collection

Request Body schema:
Array
name
string or null
address
string or null
country
string or null
Array of objects or null (ParticipantForCreationDto )

Responses

Request samples

Content type
[
  • {
    }
]

/api/orgs/{ orgId}

path Parameters
orgId
required
string <uuid>
Request Body schema:
name
string or null
address
string or null
country
string or null
Array of objects or null (ParticipantForCreationDto )

Responses

Request samples

Content type
{
  • "name": "string",
  • "address": "string",
  • "country": "string",
  • "participants": [
    ]
}

GetLeaderboardsForOrg

path Parameters
organizationId
required
string <uuid>
query Parameters
PageNumber
integer <int32>
PageSize
integer <int32>
OrderBy
string
Fields
string

Responses

/api/orgs/{ organizationId}/leaderboards

path Parameters
organizationId
required
string <uuid>
query Parameters
PageNumber
integer <int32>
PageSize
integer <int32>
OrderBy
string
Fields
string

Responses

GetLeaderboardForOrg

path Parameters
orgId
required
string <uuid>
id
required
string <uuid>

Responses

/api/orgs/{ orgId}/leaderboards/{id}

path Parameters
orgId
required
string <uuid>
id
required
string <uuid>
Request Body schema:
object (IContractResolver )

Responses

Request samples

Content type
{
  • "contractResolver": { }
}

/api/orgs/{ orgId}/leaderboards/{id}

path Parameters
orgId
required
string <uuid>
id
required
string <uuid>

Responses

/api/orgs/{ orgId}/leaderboards

path Parameters
orgId
required
string <uuid>
Request Body schema:
name
required
string [ 1 .. 30 ] characters

Responses

Request samples

Content type
{
  • "name": "string"
}

/api/orgs/{ orgId}/leaderboards/{leaderboardId}

path Parameters
orgId
required
string <uuid>
leaderboardId
required
string <uuid>
Request Body schema:
name
required
string [ 1 .. 30 ] characters

Responses

Request samples

Content type
{
  • "name": "string"
}

GetParticipantsForOrg

path Parameters
orgId
required
string <uuid>
query Parameters
MinAge
integer <int32>
MaxAge
integer <int32>
ValidAgeRange
boolean
SearchTerm
string
PageNumber
integer <int32>
PageSize
integer <int32>
OrderBy
string
Fields
string

Responses

/api/orgs/{ orgId}/participants

path Parameters
orgId
required
string <uuid>
query Parameters
MinAge
integer <int32>
MaxAge
integer <int32>
ValidAgeRange
boolean
SearchTerm
string
PageNumber
integer <int32>
PageSize
integer <int32>
OrderBy
string
Fields
string

Responses

/api/orgs/{ orgId}/participants

path Parameters
orgId
required
string <uuid>
Request Body schema:
name
required
string [ 1 .. 30 ] characters
age
integer <int32> [ 18 .. 2147483647 ]
position
required
string [ 1 .. 20 ] characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "age": 18,
  • "position": "string"
}

GetParticipantForOrg

path Parameters
orgId
required
string <uuid>
id
required
string <uuid>

Responses

/api/orgs/{ orgId}/participants/{id}

path Parameters
orgId
required
string <uuid>
id
required
string <uuid>
Request Body schema:
object (IContractResolver )

Responses

Request samples

Content type
{
  • "contractResolver": { }
}

/api/orgs/{ orgId}/participants/{id}

path Parameters
orgId
required
string <uuid>
id
required
string <uuid>

Responses

/api/orgs/{ orgId}/participants/{participantId}

path Parameters
orgId
required
string <uuid>
participantId
required
string <uuid>
Request Body schema:
name
required
string [ 1 .. 30 ] characters
age
integer <int32> [ 18 .. 2147483647 ]
position
required
string [ 1 .. 20 ] characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "age": 18,
  • "position": "string"
}

Participants

GetParticipantScores

path Parameters
participantId
required
string <uuid>
query Parameters
ParticipantId
string <uuid>
LeaderboardId
string <uuid>
PageNumber
integer <int32>
PageSize
integer <int32>
OrderBy
string
Fields
string

Responses

GetLeaderboards

path Parameters
participantId
required
string <uuid>

Responses

Root

GetRoot

header Parameters
Accept
string

Responses

Score

/api/scores

query Parameters
ParticipantId
string <uuid>
LeaderboardId
string <uuid>
PageNumber
integer <int32>
PageSize
integer <int32>
OrderBy
string
Fields
string

Responses

/api/scores

query Parameters
ParticipantId
string <uuid>
LeaderboardId
string <uuid>
PageNumber
integer <int32>
PageSize
integer <int32>
OrderBy
string
Fields
string

Responses

/api/scores

Request Body schema:
value
integer <int32> [ 1 .. 100 ]
leaderboardId
required
string <uuid>
participantId
required
string <uuid>

Responses

Request samples

Content type
{
  • "value": 1,
  • "leaderboardId": "d2c89aa0-4249-41c4-ae0f-4d78b3751977",
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7"
}

GetScore

path Parameters
id
required
string <uuid>

Responses

UpdateScore

path Parameters
id
required
string <uuid>
Request Body schema:
value
integer <int32> [ 1 .. 100 ]

Responses

Request samples

Content type
{
  • "value": 1
}

DeleteScore

path Parameters
id
required
string <uuid>

Responses

Token

/api/token/refresh

Request Body schema:
accessToken
string or null
refreshToken
string or null

Responses

Request samples

Content type
{
  • "accessToken": "string",
  • "refreshToken": "string"
}