Game Achievements / Quests

You are able to query what Achievements there are and some basic info about them.

To request Achievements for a particular game, you will need to supply the parent_id which is your game_id.

To request information about a specific achievement you will need to supply either the Achievement ID (aid) or the individual parameters: developer_id, type, and parent_id.

The parent_id parameter depends on the type of achievement. For a type of Game it would be the game_id.

URI

GET https://services.armorgames.com/services/rest/v1/achievements/{{ parent_id }}.json

Parameters

Method Name Description
ALL api_key 32 hexadecimal digits (UUID)
An access key is unique to each game.
ALL developer_id For game achievements -- a unique key to identify an achievement
tied to a particular game.
ALL type The type of achievement. Defaults to Game.
ALL aid
(optional)
Achievement ID. If you know the actual database id of the
achievement, you can reference it this way.

Response

GET https://services.armorgames.com/services/rest/v1/achievements/7446.json
{
  "version": 1,
  "code": 200,
  "message": "OK",
  "payload": [
    {
      "id": 121,
      "developer_id": "GOT_EYES",
      "parent_id": "7446",
      "type": "Game",
      "name": "I can see again!",
      "description": "Recover your optics unit.",
      "admin_description": "",
      "icon": "e3100427987c36090cff1d1903a1c76f.png?v=1352245035",
      "start_value": 0,
      "target_value": 1,
      "score": 0,
      "state": "Active",
      "completion_count": 12863,
      "created_date": 1358988582,
      "updated_date": 1358988582,
      "tags": {
        "1": "Easy"
      }
    },
    {
      "id": 122,
      "developer_id": "ENEMY_KILLED",
      "parent_id": "7446",
      "type": "Game",
      "name": "Vermin Spring Cleaning",
      "description": "Clean out enough of those filthy vermin to please mother.",
      "admin_description": "",
      "icon": "a9e7214dbf5e67f6cf19f798f404032d.png?v=1352245934",
      "start_value": 0,
      "target_value": 1,
      "score": 0,
      "state": "Active",
      "completion_count": 6644,
      "created_date": 1358988582,
      "updated_date": 1358988582,
      "tags": {
        "2": "Medium"
      }
    }
  ]
}