Content Portal API

GET achievement/{key}

Related

Get the info on an achievement with its associated rewards.

Example

GET /api/v1/achievement/test-01 HTTP/1.1
Accept: application/json
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json
ETag: ...

{
  "key": "test-01",
  "name": "Test 01",
  "description": "This is a test achievement.",
  "visibilityStart": null,
  "visibilityStop": null,
  "rewards": [
    {
      "id": "3ad449b9-ee9f-4558-a547-e85943d99e8f",
      "name": "Test 01 Reward A",
      "kind": "emblem",
      "data": {
        "image": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
        "color": "#00ff00"
      },
      "achievementKey": "test-01"
    },
    {
      "id": "33587ceb-23b9-4f03-b4be-acaebe22bacb",
      "name": "Test 01 Reward B",
      "kind": "emblem",
      "data": {
        "image": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
        "color": "#0000ff"
      },
      "achievementKey": "test-01"
    }
  ]
}

Security

Authentication is not required for this method.

URL Parameters

Name	Description	Value
key	the unique identifier of the achievement to get	string

Query Parameters

NONE

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Error responses are standard.

Response Body

Name	Description	Value
key	the unique identifier of the achievement	string
name	the display name	string
description	the description of the achievement	string
visibilityStart	if not null, the time after which this achievement should be generally visible; as a Unix timestamp	number or null
visibilityStop	if not null, the time after whcih this achievement should be no longer visible; as a Unix timestamp	number or null
rewards	the list of rewards granted by earning this achievement	Array of type Reward

Reward

Name	Description	Value
id	the ID of the reward, as a GUID with dashes	string
name	the name of the reward	string
description	the description of the reward	string
kind	a type discriminator for this reward	string
data	type-specific data for this reward	object
achievementKey	the key of the achievement with which this reward is associated	string