Ranking

Ranking system operations including event levels, participant roles, and tier management

Get event levels

get

https://api.example.com/v1https://staging-api.example.com/v1

/ranking/event-level

Retrieve all event levels for ranking calculations

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Event levels retrieved successfully

application/json

500

Internal server error

application/json

get

/ranking/event-level

HTTPcURLJavaScriptPython

GET /v1/ranking/event-level HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": [
    {
      "eventLevelId": "123e4567-e89b-12d3-a456-426614174000",
      "levelName": "National",
      "levelDescription": "National level events",
      "points": 100,
      "isActive": true,
      "createdAt": "2025-12-16T02:52:02.209Z",
      "updatedAt": "2025-12-16T02:52:02.209Z"
    }
  ]
}

Get participant roles

get

https://api.example.com/v1https://staging-api.example.com/v1

/ranking/participant-role

Retrieve all participant roles for ranking calculations

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Participant roles retrieved successfully

application/json

500

Internal server error

application/json

get

/ranking/participant-role

HTTPcURLJavaScriptPython

GET /v1/ranking/participant-role HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": [
    {
      "participantRoleId": "123e4567-e89b-12d3-a456-426614174000",
      "roleName": "Organizer",
      "roleDescription": "Event organizer role",
      "points": 50,
      "isActive": true,
      "createdAt": "2025-12-16T02:52:02.209Z",
      "updatedAt": "2025-12-16T02:52:02.209Z"
    }
  ]
}

Get event frequencies

get

https://api.example.com/v1https://staging-api.example.com/v1

/ranking/event-frequency

Retrieve all event frequencies for ranking calculations

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Event frequencies retrieved successfully

application/json

500

Internal server error

application/json

get

/ranking/event-frequency

HTTPcURLJavaScriptPython

GET /v1/ranking/event-frequency HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": [
    {
      "eventFrequencyId": "123e4567-e89b-12d3-a456-426614174000",
      "frequencyName": "Monthly",
      "frequencyDescription": "Events held monthly",
      "multiplier": 1.5,
      "isActive": true,
      "createdAt": "2025-12-16T02:52:02.209Z",
      "updatedAt": "2025-12-16T02:52:02.209Z"
    }
  ]
}

Get ranking tiers

get

https://api.example.com/v1https://staging-api.example.com/v1

/ranking/tiers

Retrieve all ranking tiers sorted by threshold score in descending order

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Ranking tiers retrieved successfully

application/json

500

Internal server error

application/json

get

/ranking/tiers

HTTPcURLJavaScriptPython

GET /v1/ranking/tiers HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": [
    {
      "rankingTierId": "123e4567-e89b-12d3-a456-426614174000",
      "tierName": "Gold",
      "tierDescription": "Gold tier ranking",
      "threshold": 1000,
      "color": "#FFD700",
      "isActive": true,
      "createdAt": "2025-12-16T02:52:02.209Z",
      "updatedAt": "2025-12-16T02:52:02.209Z"
    }
  ]
}

Generate event frequency for all members

post

https://api.example.com/v1https://staging-api.example.com/v1

/ranking/generate-event-frequency

Generate event frequency data for all members in the current year

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Event frequency generated successfully

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

post

/ranking/generate-event-frequency

HTTPcURLJavaScriptPython

POST /v1/ranking/generate-event-frequency HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Event frequency generated successfully"
}

Get event frequency multiplier

get

https://api.example.com/v1https://staging-api.example.com/v1

/ranking/event-frequency-multiplier

Retrieve event frequency multiplier settings

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Event frequency multiplier retrieved successfully

application/json

500

Internal server error

application/json

get

/ranking/event-frequency-multiplier

HTTPcURLJavaScriptPython

GET /v1/ranking/event-frequency-multiplier HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": {
    "multiplierId": "123e4567-e89b-12d3-a456-426614174000",
    "settingName": "Default Multiplier",
    "multiplierValue": 1,
    "description": "Default multiplier for event frequency calculations",
    "isActive": true,
    "createdAt": "2025-12-16T02:52:02.209Z",
    "updatedAt": "2025-12-16T02:52:02.209Z"
  }
}