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
get
/v1/quest-event/{eventId}/participant
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
get
/v1/quest-event/{eventId}/participant/list
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
get
/v1/quest-event/{eventId}/participant/rank
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
post
/v1/quest-event/{eventId}/participant/register
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
put
/v1/quest-event/{eventId}/participant/unregister
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
put
/v1/quest-event/{eventId}/participant/cancel
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
get
/v1/quest-event/{eventId}/participant/sync
GET /v1/quest-event/{eventId}/participant/sync HTTP/1.1
Host: 
Accept: */*

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

Types

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

Last updated