Participation

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

Participant

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

HTTPcURLJavaScriptPython

GET /v1/quest-event/{eventId}/participant HTTP/1.1
Host: 
Accept: */*

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

List Participants

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

HTTPcURLJavaScriptPython

GET /v1/quest-event/{eventId}/participant/list HTTP/1.1
Host: 
Accept: */*

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

Participant Rank

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

HTTPcURLJavaScriptPython

GET /v1/quest-event/{eventId}/participant/rank HTTP/1.1
Host: 
Accept: */*

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

Register Participation

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

HTTPcURLJavaScriptPython

POST /v1/quest-event/{eventId}/participant/register HTTP/1.1
Host: 
Accept: */*

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

Unregister Participation

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

HTTPcURLJavaScriptPython

PUT /v1/quest-event/{eventId}/participant/unregister HTTP/1.1
Host: 
Accept: */*

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

Cancel Participation

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

HTTPcURLJavaScriptPython

PUT /v1/quest-event/{eventId}/participant/cancel HTTP/1.1
Host: 
Accept: */*

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

Sync Participation

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

HTTPcURLJavaScriptPython

GET /v1/quest-event/{eventId}/participant/sync HTTP/1.1
Host: 
Accept: */*

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

Types

ParticipantStatus

enum ParticipantStatus {
  REGISTERED = 1,
  UNREGISTERED = 2,
  DROPPED = 3,
  CANCELLED = 4,
}

ParticipantSyncStatus

enum ParticipantSyncStatus {
  NONE = 'none',
  SYNCING = 'syncing',
  SYNCED = 'synced',
}