Shivtr

Characters

Characters show who your members are playing as in game. The Characters API lets you view, create, update, delete and restore characters.

Characters API
Fetch list of characters
GET /characters.json

Show character 1000
GET /characters/1000.json

Create new character
POST /characters.json

Update character 1000
PATCH /characters/1000.json

Delete character 1000
DELETE /characters/1000.json

Restore character 1000
PUT /characters/1000/restore.json


New or Edit Objects
{
"character": {
"game_race_id": 5000,
"game_class_id": 5001,
"game_subclass_id": 5002,
"name": "Snafzg",
"level": 50,
"spec1": "Poison",
"spec2": "Heal",
"prof1": "Stick Sharpener",
"prof2": "Mushroom Cook"
}
}


List Object
{
"characters": [
{
"id": 1000,
"name": "Snafzg",
"level": 50,
"spec1": "Poison",
"spec2": "Heal",
"prof1": "Stick Sharpener",
"prof2": "Mushroom Cook",
"created_on": "2008-06-16T14:37:20-04:00",
"member": {
"id": 2000,
"display_name": "Bipper"
},
"game_race": {
"id": 5000,
"name": "Goblin"
},
"game_class": {
"id": 5001,
"name": "Healer"
},
"game_subclass": {
"id": 5002,
"name": "Shaman"
}
}
]
}


Show Object
{
"character": {
"id": 1000,
"name": "Snafzg",
"level": 50,
"spec1": "Poison",
"spec2": "Heal",
"prof1": "Stick Sharpener",
"prof2": "Mushroom Cook",
"created_on": "2008-06-16T14:37:20-04:00",
"member": {
"id": 2000,
"display_name": "Bipper"
},
"game_race": {
"id": 5000,
"name": "Goblin"
},
"game_class": {
"id": 5001,
"name": "Healer"
},
"game_subclass": {
"id": 5002,
"name": "Shaman"
}
}
}


Example Request
To change the name of the character with the id of 1000 to Labero, send a PATCH request to /characters/1000.json with the following data:

{
"character": {
"name": "Labero"
}
}