Shivtr

DKP

DKP is used to track your guild's progress through dungeons. It tracks your raid history, items, raider standings and raider participation. The DKP API lets you fetch info on dungeons, items, raiders, standings and attendance.

Standings API
Fetch global standings
GET /dkp/global/standings.json

Fetch standings for dungeon 2000
GET /dkp/dungeons/2000/standings.json


Standings Object
{
"standings": [
{
"id": 5000,
"name": "Snafzg",
"earned": 75,
"spent": 40,
"adjust": 10,
"current": 45,
"type": "raider"
}
]
}


Attendance API
Fetch global attendance
GET /dkp/global/attendance.json

Fetch attendance for dungeon 2000
GET /dkp/dungeons/2000/attendance.json


Attendance Object
{
"attendance": [
{
"id": 5000,
"name": "Snafzg",
"thirty_attend": 15,
"lifetime_attend": 70,
"type": "raider"
}
],
"meta": {
"raids_last_thirty_days": 20,
"raids_total": 160
}
}


Dungeons API
Fetch list of dungeons
GET /dkp/dungeons.json

Show dungeon 2000
GET /dkp/dungeons/2000.json

Create new dungeon
POST /dkp/dungeons.json

Update dungeon 2000
PATCH /dkp/dungeons/2000.json

Delete dungeon 2000
DELETE /dkp/dungeons/2000.json


New or Edit Object
{
"dkp_dungeon": {
"name": "Blackwing Lair",
"description": "Blackwing Lair is a level 60, 40-man raid dungeon located at the top of Blackrock Mountain, home to Nefarian. It was implemented in patch 1.6.",
"dkp_system": 20,
"dkp_value": 5,
"dkp_hourly_value": 1
}
}


List Object
{
"dungeons": [
{
"id": 2000,
"name": "Blackwing Lair",
"description": "Blackwing Lair is a level 60, 40-man raid dungeon located at the top of Blackrock Mountain, home to Nefarian. It was implemented in patch 1.6.",
"raids_count": 30,
"dkp_system": "normal",
"dkp_value": 5,
"dkp_hourly_value": 1,
"photo": "http://s3.mmoguildsites.com/s3/dungeon_photos/2622/original.jpg"
}
]
}


Show Object
{
"dkp_dungeon": {
"id": 2000,
"name": "Blackwing Lair",
"description": "Blackwing Lair is a level 60, 40-man raid dungeon located at the top of Blackrock Mountain, home to Nefarian. It was implemented in patch 1.6.",
"raids_count": 30,
"dkp_system": 20,
"dkp_value": 5,
"dkp_hourly_value": 1
}
}


Raids API
Fetch list of raids for dungeon 2000
GET /dkp/dungeons/2000/raids.json

Show raid 500
GET /dkp/raids/500.json

Create new raid
POST /dkp/raids?dkp_dungeon_id=2000.json

Update raid 500
PATCH /dkp/raid_attributes/500.json

Delete raid 500
DELETE /dkp/raids/500.json


New or Edit Object
{
"raid": {
"dkp_dungeon_id": 2000,
"name": "Blackwing Lair",
"date": "2012-02-15T19:30:00-05:00",
"dkp_system": 20,
"dkp_value": 5,
"dkp_hourly_value": 1
}
}


List Object
{
"raids": [
{
"id": 3000,
"dkp_dungeon_id": 2000,
"name": "Blackwing Lair",
"date": "2012-02-15T19:30:00-05:00",
"dkp_system": 20,
"dkp_value": 5,
"dkp_hourly_value": 1,
"raiders_count": 25,
"items_count": 8,
"comments_count": 5
}
]
}


Show Object
{
"raid": {
"id": 3000,
"dkp_dungeon_id": 2000,
"name": "Blackwing Lair",
"date": "2012-02-15T19:30:00-05:00",
"dkp_system": 20,
"dkp_value": 5,
"dkp_hourly_value": 1,
"raiders_count": 25,
"items_count": 8,
"comments_count": 5
"dkp_bosses": [
{
"name": "Blackwing",
"dkp_vclue": 20
}
],
"dkp_items": [
{
"name": "Chestguard of the Forgotten Conqueror",
"dkp_vclue": 50
}
],
"dkp_adjustments": [
{
"reason": "sitout",
"dkp_value": 9
}
],
"dkp_raiders": [
{
"id": 1304,
"name": "Beefskewer",
"earned": 16,
"spent": 26,
"adjust": 0,
"current": -10,
"guild": null,
"game_class": {
"id": 14,
"name": "Hunter"
},
"game_subclass": null
}
]
}
}


Items API
Fetch items for dungeon 2000
GET /dkp/dungeons/2000/items.json

Fetch item 4000
GET /dkp/items/4000.json


List Object
{
"items": [
{
"id": 7000,
"name": "Shawl of the Shattered Giant",
"dkp_value": 10,
"created_on": "2012-05-08T11:57:53-04:00",
"dkp_raid": {
"id": 2000,
"name": "Blackwing Lair",
},
"dkp_raider": {
"id": 5000,
"name": "Snafzg",
}
}
]
}


Show Object
{
"dkp_item": {
"id": 7005,
"name": "Legplates of the Wayward Vanquisher",
"dkp_value": 250,
"created_on": "2012-05-08T11:57:53-04:00",
"dkp_raids": [
{
"id": 2000,
"name": "Molten Core",
}
],
"dkp_raiders": [
{
"id": 5030,
"name": "Cauchemar",
}
]
}
}