From 5e42f0050bba63d1d3d610690893dc930c7f6499 Mon Sep 17 00:00:00 2001 From: Rosario Trischitta Date: Wed, 10 Feb 2021 14:21:40 +0100 Subject: [PATCH] docs: update response fields --- docs/endpoints.rst | 187 ++++++++++++++++++++++----------------------- 1 file changed, 93 insertions(+), 94 deletions(-) diff --git a/docs/endpoints.rst b/docs/endpoints.rst index 2ac9d5eb..efa4d2b9 100644 --- a/docs/endpoints.rst +++ b/docs/endpoints.rst @@ -277,7 +277,7 @@ How many oneway streets exist within living_street streets in Heidelberg over ti "text" : "© OpenStreetMap contributors" }, "apiVersion" : "1.3.2", - "ratioResult" : [ { + "result" : [ { "timestamp" : "2016-01-01T00:00:00Z", "value" : 28660.519999999997, "value2" : 7079.26, @@ -304,7 +304,7 @@ How many oneway streets exist within living_street streets in Heidelberg over ti "text" : "© OpenStreetMap contributors" }, "apiVersion" : "1.3.2", - "ratioResult" : [ { + "result" : [ { "timestamp" : "2016-01-01T00:00:00Z", "value" : 28660.519999999997, "value2" : 7079.26, @@ -332,7 +332,7 @@ How many oneway streets exist within living_street streets in Heidelberg over ti "text" : "© OpenStreetMap contributors" }, "apiVersion" : "1.3.2", - "ratioResult" : [ { + "result" : [ { "timestamp" : "2016-01-01T00:00:00Z", "value" : 28660.519999999997, "value2" : 7079.26, @@ -358,7 +358,7 @@ How many oneway streets exist within living_street streets in Heidelberg over ti "text" : "© OpenStreetMap contributors" }, "apiVersion" : "1.3.2", - "ratioResult" : [ { + "result" : [ { "timestamp" : "2016-01-01T00:00:00Z", "value" : 28660.519999999997, "value2" : 7079.26, @@ -438,27 +438,26 @@ How often information about the roof of buildings is present? }, "apiVersion" : "1.3.2", "groupByResult" : [ { + "groupByObject" : "remainder", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 23225.0 - } ], - "groupByObject" : "remainder" + } ] }, { + "groupByObject" : "building:roof", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1418.0 - } ], - "groupByObject" : "building:roof" + } ] }, { + "groupByObject" : "building:roof:colour", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1178.0 - } ], - "groupByObject" : "building:roof:colour" + } ] } ] } - .. code-tab:: json curl (POST) { @@ -468,23 +467,23 @@ How often information about the roof of buildings is present? }, "apiVersion" : "1.3.2", "groupByResult" : [ { + "groupByObject" : "remainder", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 23225.0 - } ], - "groupByObject" : "remainder" + } ] }, { + "groupByObject" : "building:roof", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1418.0 - } ], - "groupByObject" : "building:roof" + } ] }, { + "groupByObject" : "building:roof:colour", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1178.0 - } ], - "groupByObject" : "building:roof:colour" + } ] } ] } @@ -497,23 +496,23 @@ How often information about the roof of buildings is present? }, "apiVersion" : "1.3.2", "groupByResult" : [ { + "groupByObject" : "remainder", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 23225.0 - } ], - "groupByObject" : "remainder" + } ] }, { + "groupByObject" : "building:roof", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1418.0 - } ], - "groupByObject" : "building:roof" + } ] }, { + "groupByObject" : "building:roof:colour", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1178.0 - } ], - "groupByObject" : "building:roof:colour" + } ] } ] } @@ -526,23 +525,23 @@ How often information about the roof of buildings is present? }, "apiVersion" : "1.3.2", "groupByResult" : [ { + "groupByObject" : "remainder", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 23225.0 - } ], - "groupByObject" : "remainder" + } ] }, { + "groupByObject" : "building:roof", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1418.0 - } ], - "groupByObject" : "building:roof" + } ] }, { + "groupByObject" : "building:roof:colour", "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1178.0 - } ], - "groupByObject" : "building:roof:colour" + } ] } ] } @@ -610,53 +609,53 @@ Compare length of different types of streets for two or more regions. }, "apiVersion" : "1.3.2", "groupByResult" : [ { + "groupByObject" : [ "Heidelberg", "remainder" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1650245.08 - } ], - "groupByObject" : [ "Heidelberg", "remainder" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=tertiary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 48637.96 - } ], - "groupByObject" : [ "Heidelberg", "highway=tertiary" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=secondary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 29114.72 - } ], - "groupByObject" : [ "Heidelberg", "highway=secondary" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=primary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 35297.95 - } ], - "groupByObject" : [ "Heidelberg", "highway=primary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "remainder" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 56493.26 - } ], - "groupByObject" : [ "Plankstadt", "remainder" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=tertiary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 3399.22 - } ], - "groupByObject" : [ "Plankstadt", "highway=tertiary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=secondary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 954.7 - } ], - "groupByObject" : [ "Plankstadt", "highway=secondary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=primary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 0.0 - } ], - "groupByObject" : [ "Plankstadt", "highway=primary" ] + } ] } ] } @@ -670,53 +669,53 @@ Compare length of different types of streets for two or more regions. }, "apiVersion" : "1.3.2", "groupByResult" : [ { + "groupByObject" : [ "Heidelberg", "remainder" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1650245.08 - } ], - "groupByObject" : [ "Heidelberg", "remainder" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=tertiary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 48637.96 - } ], - "groupByObject" : [ "Heidelberg", "highway=tertiary" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=secondary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 29114.72 - } ], - "groupByObject" : [ "Heidelberg", "highway=secondary" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=primary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 35297.95 - } ], - "groupByObject" : [ "Heidelberg", "highway=primary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "remainder" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 56493.26 - } ], - "groupByObject" : [ "Plankstadt", "remainder" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=tertiary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 3399.22 - } ], - "groupByObject" : [ "Plankstadt", "highway=tertiary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=secondary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 954.7 - } ], - "groupByObject" : [ "Plankstadt", "highway=secondary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=primary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 0.0 - } ], - "groupByObject" : [ "Plankstadt", "highway=primary" ] + } ] } ] } @@ -729,112 +728,112 @@ Compare length of different types of streets for two or more regions. }, "apiVersion" : "1.3.2", "groupByResult" : [ { + "groupByObject" : [ "Heidelberg", "remainder" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1650245.08 - } ], - "groupByObject" : [ "Heidelberg", "remainder" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=tertiary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 48637.96 - } ], - "groupByObject" : [ "Heidelberg", "highway=tertiary" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=secondary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 29114.72 - } ], - "groupByObject" : [ "Heidelberg", "highway=secondary" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=primary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 35297.95 - } ], - "groupByObject" : [ "Heidelberg", "highway=primary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "remainder" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 56493.26 - } ], - "groupByObject" : [ "Plankstadt", "remainder" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=tertiary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 3399.22 - } ], - "groupByObject" : [ "Plankstadt", "highway=tertiary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=secondary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 954.7 - } ], - "groupByObject" : [ "Plankstadt", "highway=secondary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=primary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 0.0 - } ], - "groupByObject" : [ "Plankstadt", "highway=primary" ] + } ] } ] } .. code-tab:: json R - { + { "attribution" : { "url" : "https://ohsome.org/copyrights", "text" : "© OpenStreetMap contributors" }, "apiVersion" : "1.3.2", "groupByResult" : [ { + "groupByObject" : [ "Heidelberg", "remainder" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 1650245.08 - } ], - "groupByObject" : [ "Heidelberg", "remainder" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=tertiary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 48637.96 - } ], - "groupByObject" : [ "Heidelberg", "highway=tertiary" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=secondary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 29114.72 - } ], - "groupByObject" : [ "Heidelberg", "highway=secondary" ] + } ] }, { + "groupByObject" : [ "Heidelberg", "highway=primary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 35297.95 - } ], - "groupByObject" : [ "Heidelberg", "highway=primary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "remainder" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 56493.26 - } ], - "groupByObject" : [ "Plankstadt", "remainder" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=tertiary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 3399.22 - } ], - "groupByObject" : [ "Plankstadt", "highway=tertiary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=secondary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 954.7 - } ], - "groupByObject" : [ "Plankstadt", "highway=secondary" ] + } ] }, { + "groupByObject" : [ "Plankstadt", "highway=primary" ], "result" : [ { "timestamp" : "2018-01-01T00:00:00Z", "value" : 0.0 - } ], - "groupByObject" : [ "Plankstadt", "highway=primary" ] + } ] } ] }