api-docs

API Sections Resource types Resource type Resources Resource Items Item

Item Keyed Data - GET

Below each item we support a keyed collection, this allows you to store JSON against a unique key for the item. The keyed data collection doesn’t have a limit, add as much data as you want.

We use the keyed data collection to store player score sheets for the game item type.

Support for the allocated-expense and budget item types is coming soon.

Request

URL : /v3/resource-types/{resource_type_id}/resources/{resource_id}/items/{item_id}/data

Method : GET

Parameters : None

Response

Code : 200 OK

Content :

[
    {
        "key": "Za4Jb370vl",
        "value": {
            "score": {
                "bonus": 35,
                "lower": 104,
                "total": 213,
                "upper": 74
            },
            "lower-section": {
                "chance": 16,
                "yahtzee": 0,
                "full_house": 0,
                "four_of_a_kind": 0,
                "large_straight": 40,
                "small_straight": 30,
                "three_of_a_kind": 18
            },
            "upper-section": {
                "ones": 2,
                "twos": 6,
                "fives": 20,
                "fours": 16,
                "sixes": 18,
                "threes": 12
            }
        },
        "created": "2022-09-06 12:19:15",
        "updated": "2022-09-06 12:42:36"
    },
    ...
]

This site is open source. Improve this page.