Category:JSON Files (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
(Finalise text)
Line 1: Line 1:
=Introduction=
=Data Transfer Format=
 
[[Php_webtags#Option_3:_JavaScript_Object_Notation|JavaScript Object Notation (.json) format]] is one of the ways to transfer data with individual items labelled, on that linked page some of the other ways to transfer data are also explained.
 
Use of this format is introduced in Cumulus MX, and ''none of the files in this category are applicable to the legacy 1.9.4  software''.
 
=Documentation for [[Cumulus_MX_Local_API|local application programming interface]]=
 
MX uses JSON format (specified as part of MX internal code) for the pages that show weather information in the [[MX Administrative Interface]], on the web server generated by MX. 
 
The Cumulus Wiki pages that document JSON usage in that interface are linked from the link in the heading above, and are not included in this category.
 
For example, the page that displays weather for today and yesterday uses the 6 formats described on [[API_Today/Yesterday_Data|this page]].
 
=Updating data to a web server=
 
This category page is the entry point for documentation of how the JSON format is used for the optional MX functionality of updating data to a web server outside Cumulus.
 
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] Appeal to contributors:
 
Please work through all linked pages, and ensure Cumulus MX documentation is completed
</div>
 
MX stores all the '''xxxx.json''' files, linked from this Wiki page, in the [[Web folder|'''web''' sub-folder]] of your MX installation.
 
There is one file [[WebsitedataT.json|websitedataT.json]] that is part of MX release distributions from 3.10.1 onwards (3.10.0 was withdrawn) as a [[Cumulus template file]]. For this case, both the template (containing the tags as described in the linked page) '''websitedataT.json''', and the file for uploading (containing data) '''websitedata.json''' can be found in the '''web''' sub-folder.
 
The templates for the other files are part of the MX internal code, so do not appear in the folder. Determine which files are generated (and appear in the '''web''' sub-folder), what data is available for your web server, and whether MX uploads them, by selections in [[MX_Administrative_Interface#Internet_Settings|1) Standard file settings, 2) Graph file settings, and 3) Daily graph file settings]].
 
Please note if you are using an older release some files may not be available, and MX development may add files that need to be documented here.
 
 


This category has been created to provide an easy way to access pages dealing with the '''xxxx.json''' files that are created by Cumulus MX in the [[Web folder|'''/web''' folder]].


Please note that the files available for you depends on which MX release you are running.


[[Category:Cumulus MX]] [[Category:Cumulus Files]]
[[Category:Cumulus MX]] [[Category:Cumulus Files]]




Determine which files are generated, and which uploaded, by selections in [[MX_Administrative_Interface#Internet_Settings|1) Standard file settings, 2) Graph file settings, and 3) Daily graph file settings]].
.

Revision as of 06:22, 15 May 2021

Data Transfer Format

JavaScript Object Notation (.json) format is one of the ways to transfer data with individual items labelled, on that linked page some of the other ways to transfer data are also explained.

Use of this format is introduced in Cumulus MX, and none of the files in this category are applicable to the legacy 1.9.4 software.

Documentation for local application programming interface

MX uses JSON format (specified as part of MX internal code) for the pages that show weather information in the MX Administrative Interface, on the web server generated by MX.

The Cumulus Wiki pages that document JSON usage in that interface are linked from the link in the heading above, and are not included in this category.

For example, the page that displays weather for today and yesterday uses the 6 formats described on this page.

Updating data to a web server

This category page is the entry point for documentation of how the JSON format is used for the optional MX functionality of updating data to a web server outside Cumulus.

Crystal Clear info.png Appeal to contributors:

Please work through all linked pages, and ensure Cumulus MX documentation is completed

MX stores all the xxxx.json files, linked from this Wiki page, in the web sub-folder of your MX installation.

There is one file websitedataT.json that is part of MX release distributions from 3.10.1 onwards (3.10.0 was withdrawn) as a Cumulus template file. For this case, both the template (containing the tags as described in the linked page) websitedataT.json, and the file for uploading (containing data) websitedata.json can be found in the web sub-folder.

The templates for the other files are part of the MX internal code, so do not appear in the folder. Determine which files are generated (and appear in the web sub-folder), what data is available for your web server, and whether MX uploads them, by selections in 1) Standard file settings, 2) Graph file settings, and 3) Daily graph file settings.

Please note if you are using an older release some files may not be available, and MX development may add files that need to be documented here.


.

This category currently contains no pages or media.

Retrieved from "https://www.cumuluswiki.org/index.php?title=Category:JSON_Files_(preserving_history)&oldid=8829"