Rankings

Operations related to member rankings and leaderboards

Get top rankings

get

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

/achievement/rankings

Get top rankings for the authenticated member with optional filtering

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typestringOptional

Type of ranking (point, time, etc.)

Default: point

statestringOptional

Filter by state

areastringOptional

Filter by area

unitstringOptional

Filter by unit

Responses

200

Top rankings retrieved successfully

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

get

/achievement/rankings

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "data": [
    {
      "memberId": "123e4567-e89b-12d3-a456-426614174000",
      "totalPoints": 1,
      "rank": 1,
      "isSelf": true,
      "memberName": "text",
      "state": "text",
      "area": "text",
      "unit": "text"
    }
  ]
}

Get member performance for parent/guardian

get

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

/achievement/rankings/{memberId}

Get performance rankings for a specific member (used by parents/guardians)

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

memberIdstring · uuidRequired

The ID of the member to get performance for

Query parameters

typestringOptional

Type of ranking (point, time, etc.)

Default: point

statestringOptional

Filter by state

areastringOptional

Filter by area

unitstringOptional

Filter by unit

Responses

200

Member performance retrieved successfully

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

get

/achievement/rankings/{memberId}

HTTPcURLJavaScriptPython

GET /v1/achievement/rankings/{memberId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": [
    {
      "memberId": "123e4567-e89b-12d3-a456-426614174000",
      "totalPoints": 1,
      "rank": 1,
      "isChild": true,
      "memberName": "text",
      "state": "text",
      "area": "text",
      "unit": "text"
    }
  ]
}

Get all member achievement rankings

get

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

/achievement/all-rankings

Get paginated list of all member achievement rankings with filtering options

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageNumberinteger · min: 1Optional

Page number for pagination

Default: 1

pageSizeinteger · min: 1 · max: 100Optional

Number of items per page

Default: 10

stateone ofOptional

Filter by state (can be array)

stringOptional

or

string[]Optional

areaone ofOptional

Filter by area (can be array)

stringOptional

or

string[]Optional

unitone ofOptional

Filter by unit (can be array)

stringOptional

or

string[]Optional

sortBystringOptional

Field to sort by

sortOrderstring · enumOptional

Sort order (asc/desc)

Possible values:

achievementTitlestringOptional

Filter by achievement title

approvalStatusstringOptional

Filter by approval status

totalPointsstringOptional

Filter by total points

totalTimestringOptional

Filter by total time

rankstringOptional

Filter by rank

memberIdstringOptional

Filter by member ID

Responses

200

All rankings retrieved successfully

application/json

400

Validation error

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

get

/achievement/all-rankings

HTTPcURLJavaScriptPython

GET /v1/achievement/all-rankings HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": [
    {
      "memberId": "123e4567-e89b-12d3-a456-426614174000",
      "memberName": "text",
      "achievementTitle": "text",
      "totalPoints": 1,
      "totalTime": 1,
      "rank": 1,
      "approvalStatus": "text",
      "state": "text",
      "area": "text",
      "unit": "text"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}