From 5e7d260cf3987cea8eee5804b869e51e5e33fb3f Mon Sep 17 00:00:00 2001
From: Nicholas Tsim <nicholastsim@gmail.com>
Date: Fri, 8 Dec 2023 15:52:17 +0000
Subject: [PATCH] Various updates for API changes

---
 .../index.html.md.erb                         |  8 +++---
 .../quick-start/index.html.md.erb             | 25 +++++++++++--------
 2 files changed, 18 insertions(+), 15 deletions(-)

diff --git a/source/getting-started/creating-advanced-data-set-queries/index.html.md.erb b/source/getting-started/creating-advanced-data-set-queries/index.html.md.erb
index 081aaab..863f4e4 100644
--- a/source/getting-started/creating-advanced-data-set-queries/index.html.md.erb
+++ b/source/getting-started/creating-advanced-data-set-queries/index.html.md.erb
@@ -1,6 +1,6 @@
 ---
 title: Creating advanced data set queries
-last_reviewed_on: 2023-06-19
+last_reviewed_on: 2023-12-08
 review_in: 6 months
 weight: 3
 ---
@@ -49,7 +49,7 @@ can be in the response and must be populated using the IDs of facets from the da
 (see the [Get a data set's metadata](/endpoints/GetDataSetMeta/index.html) endpoint).
 
 The `indicators` property controls what data values are shown in the results. This should simply
-contain a list of indicator IDs, their names or both. For example, using the following indicators:
+contain a list of indicator IDs. For example, using the following indicators:
 
 ```json
 {
@@ -62,8 +62,8 @@ Each result in the response would look like the following:
 ```json
 {
   "values": {
-    "name-of-indicator-1": "123",
-    "name-of-indicator-2": "245"
+    "id-of-indicator-1": "123",
+    "id-of-indicator-2": "245"
   }
 }
 ```
diff --git a/source/getting-started/quick-start/index.html.md.erb b/source/getting-started/quick-start/index.html.md.erb
index c7937fe..44f195a 100644
--- a/source/getting-started/quick-start/index.html.md.erb
+++ b/source/getting-started/quick-start/index.html.md.erb
@@ -1,6 +1,6 @@
 ---
 title: Quick start
-last_reviewed_on: 2023-06-19
+last_reviewed_on: 2023-12-08
 review_in: 6 months
 weight: 2
 ---
@@ -99,16 +99,18 @@ This endpoint will respond with something like the following (parts have been om
   "results" : [
     {
       "_links" : {
-        "dataSets" : {
-          "href" : "/api/v1/publications/cbbd299f-8297-44bc-92ac-558bcf51f8ad/data-sets"
-        },
         "self" : {
           "href" : "/api/v1/publications/cbbd299f-8297-44bc-92ac-558bcf51f8ad"
+        },
+        "dataSets" : {
+          "href" : "/api/v1/publications/cbbd299f-8297-44bc-92ac-558bcf51f8ad/data-sets"
         }
       },
       "id" : "cbbd299f-8297-44bc-92ac-558bcf51f8ad",
       "slug" : "Pupil-absence-in-schools-in-England",
-      "title" : "Pupil absence in schools in England"
+      "title" : "Pupil absence in schools in England",
+      "summary": "Pupil absence, including overall, authorised and unauthorised absence...",
+      "lastPublished": "2023-11-10T09:15:00+00:00"
     }
   ]
 }
@@ -177,7 +179,9 @@ For example, given the following publication (parts omitted for brevity):
 {
   "id" : "cbbd299f-8297-44bc-92ac-558bcf51f8ad",
   "slug" : "Pupil-absence-in-schools-in-England",
-  "title" : "Pupil absence in schools in England"
+  "title" : "Pupil absence in schools in England",
+  "summary": "Pupil absence, including overall, authorised and unauthorised absence...",
+  "lastPublished": "2023-11-10T09:15:00+00:00"
 }
 ```
 
@@ -269,9 +273,8 @@ The endpoint will return something that looks like the following:
   "totalResults": 1000,
   "indicators": [
     {
-      "id": "772c60cd",
+      "id": "sess_authorised",
       "label": "Number of authorised absence sessions",
-      "name": "sess_authorised",
       "unit": "",
       "decimalPlaces": 0
     }
@@ -316,8 +319,8 @@ The endpoint will return something that looks like the following:
   ],
   "filters": [
     {
+      "id": "school_type",
       "label": "School type",
-      "name": "school_type",
       "options": [
         {
           "id": "0d194014",
@@ -335,7 +338,7 @@ The endpoint will return something that looks like the following:
 ```
 
 Indicators can be found under the `indicators` key. Each indicator will at least have a unique `id`,
-a human-readable `label` and a `name` used in the underlying data file.
+and a more human-readable `label`.
 
 The core facets are found under the `timePeriods`, `geographicLevels` and `locations` keys, whilst
 non-core facets are found under the `filters` key. These are grouped by their filter type
@@ -495,7 +498,7 @@ response that looks like:
 The `results` part of this response contains a list where each item is a facet combination and the
 data matching it. The data itself can be found in each result's `values` property.
 
-The `values` property of each result is a dictionary where the key is the name of the indicator
+The `values` property of each result is a dictionary where the key is the ID of the indicator
 and the value is the data collected. In the above example, the number of authorised absence sessions
 (`sess_authorised`) is 1708016.