EPGP#

POST /api/epgp/adjustments#

CreateAdjustment

Request body

Model: EpgpAdjustmentCreate

Field

Type

Required

Description

member_id

integer

yes

kind

LedgerKind

yes

amount

integer

yes

reason

string

yes

Response 201 — Document created, URL follows

Model: EpgpLedgerRow

Field

Type

Required

Description

id

string (uuid)

yes

at

string (date-time)

yes

kind

LedgerKind

yes

amount

integer

yes

decayed

number

yes

reason

string

yes

note

string | null

yes

character

string | null

yes

member_id

integer | null

yes

member_name

string | null

yes

officer

string

yes

item_name

string | null

yes

voided

boolean

yes

GET /api/epgp/characters#

ListCharacters

Response 200 — Request fulfilled, document follows

Model: EpgpCharacterList

Field

Type

Required

Description

characters

array of EpgpCharacter

yes

PUT /api/epgp/characters/{character_id}#

UpdateCharacter

Parameters

Name

In

Type

Required

Description

character_id

path

string (uuid)

yes

Request body

Model: EpgpCharacterUpdate

Field

Type

Required

Description

member_id

integer | null

yes

is_main

boolean

yes

Response 200 — Request fulfilled, document follows

Model: EpgpCharacter

Field

Type

Required

Description

id

string (uuid)

yes

name

string

yes

realm

string

yes

class

WowClass | null

yes

member_id

integer | null

yes

member_name

string | null

yes

is_main

boolean

yes

source

CharacterSource

yes

last_seen_at

string (date-time) | null

yes

GET /api/epgp/game-import#

GetGameImport

Response 200 — Request fulfilled, document follows

Model: EpgpGameImport

Field

Type

Required

Description

payload

string

yes

generated_at

string (date-time)

yes

POST /api/epgp/imports#

ImportPayload

Request body

Model: EpgpImportBody

Field

Type

Required

Description

payload

string

yes

Response 200 — Request fulfilled, document follows

Model: EpgpImportResult

Field

Type

Required

Description

recorder

string

yes

sessions

ImportCounts

yes

encounters

ImportCounts

yes

loot

LootImportCounts

yes

awards

AwardImportCounts

yes

unlinked_characters

array of string

no

attendance

ImportAttendanceResult

yes

conflicts

array of string

no

roster

RosterImportCounts

no

professions

ProfessionImportCounts

no

signups

SignupImportCounts

no

bank

BankImportCounts

no

announcements

AnnouncementImportCounts

no

recruits

RecruitImportCounts

no

member_notes

MemberNoteImportCounts

no

GET /api/epgp/ledger#

GetLedger

Parameters

Name

In

Type

Required

Description

member_id

query

integer | null

no

character

query

string | null

no

limit

query

integer

no

before

query

string (date-time) | null

no

Response 200 — Request fulfilled, document follows

Model: EpgpLedgerPage

Field

Type

Required

Description

entries

array of EpgpLedgerRow

yes

GET /api/epgp/loot#

GetLoot

Parameters

Name

In

Type

Required

Description

limit

query

integer

no

Response 200 — Request fulfilled, document follows

Model: EpgpLootPage

Field

Type

Required

Description

items

array of EpgpLootRow

yes

GET /api/epgp/member-notes#

ListNotes

Parameters

Name

In

Type

Required

Description

member_id

query

integer | null

no

Response 200 — Request fulfilled, document follows

Model: EpgpMemberNoteList

Field

Type

Required

Description

notes

array of EpgpMemberNoteRow

yes

GET /api/epgp/progression#

GetProgression

Response 200 — Request fulfilled, document follows

Model: EpgpProgression

Field

Type

Required

Description

instances

array of EpgpProgressionInstance

yes

GET /api/epgp/recruits#

ListRecruits

Response 200 — Request fulfilled, document follows

Model: EpgpRecruitList

Field

Type

Required

Description

recruits

array of EpgpRecruitRow

yes

PUT /api/epgp/recruits/{recruit_id}#

UpdateRecruit

Parameters

Name

In

Type

Required

Description

recruit_id

path

string (uuid)

yes

Request body

Model: EpgpRecruitUpdate

Field

Type

Required

Description

status

RecruitStatus | null

no

note

string | null

no

checklist

RecruitChecklist | null

no

Response 200 — Request fulfilled, document follows

Model: EpgpRecruitRow

Field

Type

Required

Description

id

string (uuid)

yes

character

string

yes

class

WowClass | null

no

status

RecruitStatus

yes

note

string | null

yes

checklist

RecruitChecklist

yes

votes

array of ExportRecruitVote

yes

member_id

integer | null

yes

at

string (date-time)

yes

POST /api/epgp/recruits/{recruit_id}/votes#

AddVote

Parameters

Name

In

Type

Required

Description

recruit_id

path

string (uuid)

yes

Request body

Model: EpgpRecruitVoteCreate

Field

Type

Required

Description

vote

RecruitVoteChoice

yes

Response 201 — Document created, URL follows

Model: EpgpRecruitRow

Field

Type

Required

Description

id

string (uuid)

yes

character

string

yes

class

WowClass | null

no

status

RecruitStatus

yes

note

string | null

yes

checklist

RecruitChecklist

yes

votes

array of ExportRecruitVote

yes

member_id

integer | null

yes

at

string (date-time)

yes

GET /api/epgp/roster#

GetRoster

Response 200 — Request fulfilled, document follows

Model: EpgpRoster

Field

Type

Required

Description

members

array of EpgpRosterRow

yes

PUT /api/epgp/roster/{member_id}#

UpdateRoster

Parameters

Name

In

Type

Required

Description

member_id

path

integer

yes

Request body

Model: EpgpRosterUpdate

Field

Type

Required

Description

raid_status

RaidStatus | null

yes

Response 200 — Request fulfilled, document follows

Model: EpgpRosterRow

Field

Type

Required

Description

member_id

integer

yes

name

string

yes

raid_status

RaidStatus | null

yes

trial_started_at

string (date-time) | null

yes

GET /api/epgp/standings#

GetStandings

Response 200 — Request fulfilled, document follows

Model: EpgpStandings

Field

Type

Required

Description

generated_at

string (date-time)

yes

rules

EpgpRules

yes

rows

array of EpgpStandingsRow

yes

GET /api/epgp/sync-tokens#

ListSyncTokens

Response 200 — Request fulfilled, document follows

Model: EpgpSyncTokenList

Field

Type

Required

Description

tokens

array of EpgpSyncTokenSummary

yes

POST /api/epgp/sync-tokens#

CreateSyncToken

Request body

Model: EpgpSyncTokenCreate

Field

Type

Required

Description

name

string

yes

Response 201 — Document created, URL follows

Model: EpgpSyncTokenCreated

Field

Type

Required

Description

id

string (uuid)

yes

name

string

yes

token

string

yes

DELETE /api/epgp/sync-tokens/{token_id}#

RevokeSyncToken

Parameters

Name

In

Type

Required

Description

token_id

path

string (uuid)

yes

Response 204 — Request fulfilled, nothing follows

GET /api/me/characters#

ListMyCharacters

Response 200 — Request fulfilled, document follows

Model: EpgpCharacterList

Field

Type

Required

Description

characters

array of EpgpCharacter

yes

POST /api/me/characters#

ClaimCharacter

Request body

Model: MyCharacterCreate

Field

Type

Required

Description

name

string

yes

realm

string | null

no

class

WowClass | null

no

Response 201 — Document created, URL follows

Model: EpgpCharacter

Field

Type

Required

Description

id

string (uuid)

yes

name

string

yes

realm

string

yes

class

WowClass | null

yes

member_id

integer | null

yes

member_name

string | null

yes

is_main

boolean

yes

source

CharacterSource

yes

last_seen_at

string (date-time) | null

yes

DELETE /api/me/characters/{character_id}#

DeleteCharacter

Parameters

Name

In

Type

Required

Description

character_id

path

string (uuid)

yes

Response 204 — Request fulfilled, nothing follows