Admin at 01:05, 11 April 2021

2021-04-11T01:05:56Z

Show changes

Admin at 01:04, 11 April 2021

2021-04-11T01:04:09Z

Show changes

Admin at 20:57, 27 December 2020

2020-12-27T20:57:57Z

Show changes

Admin: Admin moved page How it works/APIs to How it works/Advanced use/APIs without leaving a redirect

2020-11-23T21:09:00Z

Admin moved page How it works/APIs to How it works/Advanced use/APIs without leaving a redirect

Admin at 15:58, 15 November 2020

2020-11-15T15:58:28Z

Admin at 15:58, 15 November 2020

2020-11-15T15:58:08Z

Admin at 08:07, 2 November 2020

2020-11-02T08:07:11Z

Admin at 08:02, 2 November 2020

2020-11-02T08:02:45Z

Admin at 06:18, 2 November 2020

2020-11-02T06:18:07Z

Admin at 16:12, 7 October 2020

2020-10-07T16:12:13Z

@@ Line 978: / Line 978: @@
 |array of titles corresponding to the complete page's path. This allows to use a slash as part of the title at the same time handling the page path correctly
 |-
-|creation
+|creation_time
 |timestamp of creation time of the page
 |-

@@ Line 977: / Line 977: @@
 |title_structure
 |array of titles corresponding to the complete page's path. This allows to use a slash as part of the title at the same time handling the page path correctly
 |-
 |modification_time

← Older revision		Revision as of 08:07, 2 November 2020
Line 910:		Line 910:
	\|POST		\|POST
	\|}		\|}
		+
		+	'''Note''': The key "title" is an alias for the key "pages" when the latter contains only one record.
		+
		+	The key "root_page" can be combined with the key "pages" (one can ask a set of sub-pages, requiring full page's data only for some of them, or for others pages under the same TOC)

@@ Line 929: / Line 929: @@
 |-
 |organization_information
-|retrieves organization information (id and name)
+|retrieves information of the organization (if any) related to the set of pages
 |-
 |include_hidden

@@ Line 19: / Line 19: @@
 The following endpoint retrieves one or more wiki pages under a specific path.
-If requested, it also returns a structured table of contents associated to the set of returned pages, a useful set of data for each page (including the rendered html, categories, all the related semantic properties, the detected language, the original page url, and more), and information on the related organization.
+If requested, it also returns a structured table of contents associated to the set of returned pages, a useful set of data for each page (including the rendered html, categories, all the related semantic properties, the detected language, the original page url, and more), and information about the organization related to the requested set of pages (if any).
 It is enough flexible to make possible the [https://culturaitaliana.org/pages/How_it_works front-end site corresponding to this set of pages] (the link points to itself in the eventuality you are already reading herein), which provides server-side rendering, storage of pages and table of contents within a client-side database, previous/next page navigation, filtering of pages based on detected languages, and more: all that using just 2 calls (one server side, and one client side) of the following API !
@@ Line 40: / Line 40: @@
 </pre>
-The request will return only the page set as title, with all data related to it, and the organization information.
+The request will return only the page set as title, with all data related to it.
@@ Line 84: / Line 84: @@
 <pre class="language-xxxx">
-https://culturaitaliana.org/api/wikipages?root_page=How_it_works&pages=Application_form|Join_team&subpages_data=modification_time|title_structure&options=TOC|organization_information
+https://culturaitaliana.org/api/wikipages?root_page=How_it_works&pages=Application_form|Join_team&subpages_data=modification_time|title_structure&options=TOC
 </pre>
-The request will return all subpages of the indicated root_page, retrieving only modification_time and title_structure for each of them, and all the available data (including html content) of the pages 'Application_form' and 'Join_team'. It will also include the related table of contents (TOC) and organization's information.
+The request will return all sub-pages of the indicated root_page, retrieving only modification_time and title_structure for each of them, and all the available data (including html content) of the pages 'Application_form' and 'Join_team'. It will also include the table of contents (TOC) related to the root_page (if the root page itself or one of the parent page have any).
@@ Line 95: / Line 95: @@
+{
     "success":true,
     "TOC":[
+       {
@@ Line 529: / Line 525: @@
 </pre>
-The request will return all the subpages of the indicated root_page newer than the provided timestamp, with all page data for each of them.
+The request will return all the sub-pages of the indicated root_page newer than the provided timestamp, with all page's data of each of them.
@@ Line 852: / Line 848: @@
-'''Note''' Currently (September 2020) the TOC also includes a property "active_kids" on folder nodes (nodes with the "path" property are supposed to be pages, otherwise folders) to let UIs determine whether display a branch or not without looping through its direct children. The feature is used on the front-end as well: for instance [https://culturaitaliana.org/organizations/Istituto_cultura_italiana_(NGO) this page] does contain active "news" pages without active parent, so they are shown when [https://culturaitaliana.org/browse/world/news browsing through semantic data] but not on the navigation panel of the organization's page.
+'''Note''' Currently (September 2020) the TOC also includes a property "active_kids" on folder nodes (nodes with the "path" property are supposed to be pages, otherwise folders) to let UIs determine whether display a branch or not without looping through its direct children. The feature is used on the front-end as well: for instance [https://culturaitaliana.org/organizations/Istituto_cultura_italiana_(NGO) this organization's page] contains one or more "News" pages (pages with the form "News") which are not direct children of it, or whose "parent" page is inactive, so they are shown when [https://culturaitaliana.org/browse/world/news browsing through semantic data] but not on the organization's page itself.
@@ Line 875: / Line 871: @@
 |-
 |pages
-|a list of page titles which will be served with the full set of page data
+|a list of page titles which will be served with the full set of page's data
 |list of page titles (pipe separated)
 |suggested POST
@@ Line 890: / Line 886: @@
 |-
 |subpages data
-|Page data to be retrieved for all subpages of the root_page
+|Page's data to be retrieved for all sub-pages of the root_page
 |one or more of the following: (pipe separated) html, url, language_detected, form_name, form_data, categories, title_structure, modification_time
 |POST or GET
@@ Line 897: / Line 893: @@
 |Query options (see dedicated table below for a description of each option)
 |one or more of the following: (pipe separated) TOC, complete_TOC, all_subpages_data, organization_information, include_hidden
 |POST or GET
 |-
@@ Line 932: / Line 923: @@
 |-
 |complete_TOC
-|retrieves the complete TOC of all the pages of a given organization even if the provided root_page is a subpage of it
+|retrieves the complete TOC of all the sub-pages of a given n even if the provided root_page is a subpage of it
 |-
 |all_subpages_data
@@ Line 941: / Line 932: @@
 |-
 |include_hidden
-|includes pages hidden in the [[How it works/Table of contents|Table of contents]] of a given organization
+|includes pages hidden in the related TOC
 |}
-'''Returned data for each page'''
+'''Available data for each page'''
 {| class="wikitable"

← Older revision	Revision as of 21:09, 23 November 2020
(No difference)

← Older revision		Revision as of 16:12, 7 October 2020
Line 852:		Line 852:


−	'''Note''' Currently (September 2020) the TOC also includes a property "active_kids" on folder nodes (nodes with the "path" property are supposed to be pages, ~~without~~ folders) to let UIs determine whether display a branch or not without looping through its direct children. The feature is used on the front-end as well: for instance [https://culturaitaliana.org/organizations/Istituto_cultura_italiana_(NGO) this page] does contain active "news" pages without active parent, so they are shown when [https://culturaitaliana.org/browse/world/news browsing through semantic data] but not on the navigation panel of the organization's page.	+	'''Note''' Currently (September 2020) the TOC also includes a property "active_kids" on folder nodes (nodes with the "path" property are supposed to be pages, otherwise folders) to let UIs determine whether display a branch or not without looping through its direct children. The feature is used on the front-end as well: for instance [https://culturaitaliana.org/organizations/Istituto_cultura_italiana_(NGO) this page] does contain active "news" pages without active parent, so they are shown when [https://culturaitaliana.org/browse/world/news browsing through semantic data] but not on the navigation panel of the organization's page.

How it works/Advanced use/APIs - Revision history

Admin at 01:05, 11 April 2021

Admin at 01:04, 11 April 2021

Admin at 20:57, 27 December 2020

Admin: Admin moved page How it works/APIs to How it works/Advanced use/APIs without leaving a redirect

Admin at 15:58, 15 November 2020

Admin at 15:58, 15 November 2020

Admin at 08:07, 2 November 2020

Admin at 08:02, 2 November 2020

Admin at 06:18, 2 November 2020

Admin at 16:12, 7 October 2020