User objects

Each pointercrate user is represented by a User object.

If the display name is not null, it will replace a user’s username wherever their name is displayed.

There is only one form of user objects:

Example object

{
  "display_name": "stadust",
  "id": 2,
  "name": "stardust1971",
  "permissions": 0,
  "youtube_channel": null
}

Named ID

Object representing some generic name-id pair.

Example object

{
    "id": 5,
    "name": "cat"
}

Nationality objects

Object representing some nation

Subdivision objects

Object representing some state with in a nation

Example object

{
  "nation": "United States",
  "country_code": "US",
  "subdivision": {
    "iso_code": "OH",
    "name": "Ohio"
  }
}

Record objects

Each record on the list is represented by a Record object. The following invariants hold true for all player objects

• The progress value lies within demon.requirement and 100
• Every video value is unique
• Every combination of demon, player and status values is unique
• Every video value is in one of the formats listed here, or null

The object only contains the submitter information if the requestee has ListModerator permissions. The object only contains the notes if the requester has ListHelper permissions. Requests without ListHelper permissions can only retrieve approved records.

Minimal Form

The minimal (formerly called embedded form) form of record objects is returned if a record object is part of another object.

Depending on the context the object is returned in, one (or both) of the following fields will be present:

Listed Form

The listed form (formerly called short form) of record objects is returned by GET /records/.

Full Form

The full (formerly called long form) form of record objects is returned by GET /records/{record_id}.

Enum RecordStatus

Example objects

Minimal form

Here with an embedded demon object:

{
  "id": 1,
  "progress": 100,
  "demon": {
    "name": "Cadrega City",
    "position": 1
  },
  "status": "approved",
  "player": "Aquatias"
}

Full form

Here without an embedded submitter object

{
  "demon": {
    "name": "Cadrega City",
    "position": 34
  },
  "id": 2,
  "player": {
    "banned": false,
    "id": 5,
    "name": "AeonAir"
  },
  "progress": 100,
  "status": "approved",
  "submitter": null,
  "video": null,
  "notes":[]
}

Record notes

Users with ListHelper and up permissions can comment on records by leaving record notes. Submitters of records can also add initial notes to records. Each record can have an arbitrary amount of notes, and each note keeps track of who created and subsequently edited it.

Example objects

{
  "author":"stadust",
  "content":"This is a new record note :o",
  "editors":["stadust"],
  "id":3,
  "transferred":false
}

Demon objects

Each demon on the list is represented by a Demon object. The following assumptions can be made about these:

• The requirement value lies between 0 and 100.
• There are no holes in the positioning and the position value is greater than 0
• Every video value, if provided, is in one of the formats listed here, or null

Note that although on the website the record requirement for demons on the extended list is always displayed as 100%, Demon objects still save their requirement from when they were on the main list.

Minimal Form

When embedded into other objects (for example, as part of a Record), only the following minimal representation of each demon is provided:

Listed Form

When retrieving demons via GET /demons/, only the following partial representation of each demon is provided:

Full Form

The listed record objects do not contain the current demon embedded into the demon field.

Example objects

Minimal form

{
  "name": "Cadrega City",
  "position": 34,
  "id": 1
}

Listed form

{
  "name": "Cadrega City",
  "position": 34,
  "id": 1,
  "publisher": {
    "name": "Pennutoh",
    "id": 123,
    "banned": false
  },
  "verifier": {
    "banned": false,
    "id": 3,
    "name": "Sunix"
  },
  "thumbnail": "https://i.ytimg.com/vi/cHEGAqOgddA/mqdefault.jpg",
  "video": "https://www.youtube.com/watch?v=cHEGAqOgddA"
}

Long form

{
  "creators": [
    {
      "banned": false,
      "id": 2,
      "name": "Pennutoh"
    }
  ],
  "name": "Cadrega City",
  "position": 34,
  "id": 1,
  "publisher": {
    "banned": false,
    "id": 2,
    "name": "Pennutoh"
  },
  "requirement": 54,
  "verifier": {
    "banned": false,
    "id": 3,
    "name": "Sunix"
  },
  "thumbnail": "https://i.ytimg.com/vi/cHEGAqOgddA/mqdefault.jpg",
  "video": "https://www.youtube.com/watch?v=cHEGAqOgddA"
}

Player objects

Each player on the list is represented by a Player object. The following invariant holds true for any player object:

• If the player is banned, they do not have any approved or submitted records on the list

Note that it is not possible to retrieve a player’s demonlist score via the API. You can calculate it yourself based on the records list

Minimal Form

When part of the representation of another object, a player has the following fields:

Listed Form

When retrieving players via GET /players/

Full Form

The listed record objects do not contain the current player embedded into the player field.

Example objects

Minimal form

{
  "id": 4,
  "name": "Pennutoh",
  "banned": false
}

Listed Form

{
  "id": 4,
  "name": "Pennutoh",
  "banned": false,
  "nationality": {
    "nation": "Andorra",
    "country_code": "AD"
  }
}

Full form

{
  "banned": false,
  "beaten": [],
  "records": [
    {
      "id": 12,
      "name": "Cadrega City",
      "progress": 100,
      "status": "approved"
    }
  ],
  "id": 2,
  "name": "Pennutoh",
  "nationality": {
    "nation": "Andorra",
    "country_code": "AD"
  },
  "published": [
    {
      "name": "Cadrega City",
      "position": 34
    }
  ],
  "verified": []
}

Player claims

Represents

Example objects

{
  "user_id": 12,
  "player_id": 363,
  "verified": true,
  "lock_submissions": false
}

Submitter objects

Everyone who submits a record gets assigned an incremental submitter id, internally used to keep track of who has been banned from submitting records. The following invariant holds true for any submitter object:

• If the submitter is banned, he cannot submit new records and all his previously submitted records are either marked as approved or rejected

Example object

{
  "banned": true,
  "id": 7
}

Error objects

In case of a client or a (not completely fatal) server error, the API will provide an Error object with some information about what went wrong.

Although each HTTP response comes with a status code, you can still calculate the status code from the error code by performing integer division by 100

Example object

{
  "code": 42217,
  "data": {
    "existing": 13
  },
  "message": "This records has already been submitted"
}