View source for Help:API:ask/Quantity

{{doc.info
 | master page = Help:API:ask/Quantity
 | status = effective
 | progress = 100
 | priority = 2
 | minversion = 1.7.0
 | maxversion =
}}{{Factbox
 |Displaytitle=API result "Quantity"
 |Name=Quantity
 |Description=API result format for data type Quantity
 |Keyword=API; API module; API result; action ask; ask; action askargs; askargs; datatype Quantity
 |Example=Help:Type_Quantity; Help:API:ask; Help:API:askargs
 |Collection=
 |Toc=No
}}

When using the [[Help:API|API]] to query for semantic data, different [[Help:List of datatypes|datatypes]] may have different output formats. This page gives an '''example for {{DataType|Quantity}} using {{Api|ask}}'''. {{Api|askargs}} however uses the same output format.

<div style="clear: both"></div>
== Example JSON result output ==
You can experiment with the api result output yourself by using the [[Special:APISandbox|API Sandbox]]. The following example can be reproduced <span class="plainlinks">[https://www.semantic-mediawiki.org/wiki/Special:ApiSandbox#action=ask&format=json&query=%5B%5Bhas%20area%3A%3A%2B%5D%5D%7C%3Fhas%20area%7Climit%3D1%7Cmainlabel%3D- here]</span>.

<syntaxhighlight lang="json">
{
    "query": {
        "printrequests": [
            {
                "label": "Has area",
                "key": "Has_area",
                "redi": "",
                "typeid": "_qty",
                "mode": 1,
                "format": ""
            }
        ],
        "results": {
            "Demo:Amsterdam": {
                "printouts": {
                    "Has area": [
                        {
                            "value": 219,
                            "unit": "km\u00b2"
                        }
                    ]
                }
            }
        },
        "serializer": "SMW\\Serializers\\QueryResultSerializer",
        "version": 2,
        "meta": {
            "hash": "b4abea6ee35b037b4c32ec181be89fdd",
            "count": 1,
            "offset": 0,
            "source": "",
            "time": "0.003392"
        }
    }
}
</syntaxhighlight>
[[Category:API example]]