XBorg SDK
  • Introduction
  • Community
    • Details
    • Resources
    • Inventory
    • Prizes
    • Store
    • Achievements
  • User
    • Profile
    • Authentication
    • Socials
    • Wallets
  • Quests
    • User
    • Community
  • Quest Events
    • Details
    • Participation
    • Leaderboard
  • Blockchain
  • Configuration
  • Shared Library SDK
    • Authentication & Setup
    • Quest Management
    • Event Management
      • Working with Events
      • Events Lifecycle
      • Events Requirements
      • Events Quests
      • Events Rewards
    • Quest Rewards
    • 3D Avatar
Powered by GitBook
On this page
  1. Quest Events

Participation

The Quest Events API provides a comprehensive set of endpoints for users to interact with a quest event.

PreviousDetailsNextLeaderboard

Last updated 5 months ago

Participant

List Participants

Participant Rank

Register Participation

Unregister Participation

Cancel Participation

Sync Participation

Types

enum ParticipantStatus {
  REGISTERED = 1,
  UNREGISTERED = 2,
  DROPPED = 3,
  CANCELLED = 4,
}
enum ParticipantSyncStatus {
  NONE = 'none',
  SYNCING = 'syncing',
  SYNCED = 'synced',
}

Retrieve quest event participation data for a user

get
Path parameters
eventIdstringRequired
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
get
GET /v1/quest-event/{eventId}/participant HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

List registered participants for a quest event.

get
Path parameters
eventIdstringRequired
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
get
GET /v1/quest-event/{eventId}/participant/list HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Retrieve a users rank in a quest event.

get
Path parameters
eventIdstringRequired
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
get
GET /v1/quest-event/{eventId}/participant/rank HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Register a user for a quest event.

post
Path parameters
eventIdstringRequired
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
post
POST /v1/quest-event/{eventId}/participant/register HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Unregister a user for a quest event.

put
Path parameters
eventIdstringRequired
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
put
PUT /v1/quest-event/{eventId}/participant/unregister HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Cancel participation in a quest event.

put
Path parameters
eventIdstringRequired
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
put
PUT /v1/quest-event/{eventId}/participant/cancel HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Sync points in a score based event.

get
Path parameters
eventIdstringRequired
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
get
GET /v1/quest-event/{eventId}/participant/sync HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}
  • Participant
  • GETRetrieve quest event participation data for a user
  • List Participants
  • GETList registered participants for a quest event.
  • Participant Rank
  • GETRetrieve a users rank in a quest event.
  • Register Participation
  • POSTRegister a user for a quest event.
  • Unregister Participation
  • PUTUnregister a user for a quest event.
  • Cancel Participation
  • PUTCancel participation in a quest event.
  • Sync Participation
  • GETSync points in a score based event.
  • Types