JSON (Type of variable)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Importing files in JSON format
Assignment and reading
Properties specific to the description of JSON variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

JSON (Type of variable)

In french: JSON

The JSON type makes it possible to simplify actions on data in JSON format.

Example

V is JSON

Syntax

Declaring and assigning a JSON type Hide the details

<Variable name>:

Name of variable to declare.

<Value>:

Value that will be assigned to the variable. A JSON variable can be assigned with:
NULL,
a Boolean (True or False),
a numeric.
a date (automatically converted into string in RFC format),
an Ansi or Unicode string that contains data,
an Ansi string that contains data in JSON format.

Remarks

Importing files in JSON format

JSON variables can be declared by specifying an example document (a text file). The structure of this document will be read by WINDEV, WEBDEV and WINDEV Mobile. Therefore, the automatic completion will be available for the names of nodes in the code editor.

To declare a JSON variable with an example document:

Add the text document to the project using one of the following methods:
- on the "Project" pane, in the "Project" group, expand " List of elements" and click "List of project elements". The list of project elements is displayed. Click on "Add" and select the text document.
- Drag the file and drop it in the "External descriptions" folder of the "Project explorer" pane.
- in the "Project explorer" pane, select the "External descriptions" folder, then "Import an XML or JSON into this project" from the popup menu.
The JSON document appears in the "External Descriptions" folder of the Project explorer. You have the ability to see its structure.
Declare the variable as follows:

<Variable name> is JSON, description = <Document name>

or

<Variable name> is JSON <description = "Document name">

<Document name> can correspond to the name of the example document (with or without extension).
Remark: This declaration can be automatically obtained by dropping the name of the text document from the project explorer.
You now have the ability to access the variable nodes by their names. These names are automatically proposed by the mechanism for automatic completion of the code editor.

Remark: It is also possible to obtain compilation assistance and verification on a sub-part of the JSON by using the following syntax:

v2 is JSON, description="JSONFile.Member.SubMember"

v2 is JSON, <description="JSONFile.Member.SubMember">

Assignment and reading

Assigning a JSON variable

The syntax "j = ..." tries to analyze the value as a JSON string. This syntax is "almost" equivalent to "j..JSONFormat = ..." except if the JSON string is invalid: it is then copied directly without interpretation, as the value of the JSON element

The syntax "j..Member = ..." assigns the value of the member. This syntax is equivalent to "j..Member..Value =... ".

Reading a JSON variable

The syntax "... = j" returns the JSON string corresponding to the content of the variable. This syntax is equivalent to "... =j..JSONFormat ".

The syntax "... = j..Member" returns the value of the member. This syntax is equivalent to "... =j..Member..Value".

Properties specific to the description of JSON variables

The following properties can be used to handle a JSON variable:

Property name	Type used	Effect

Exist	Boolean	True if the element exists, False otherwise. This property is available in read-only.
JSONFormat	Character string	JSON string corresponding to the value of the element. If this string is not in JSON format, a warning is displayed.
Member	Array of JSON variables	Members of the JSON variable.
Name	Character string	Member name. Corresponds to empty string ("") if there is no member.
Count	Integer	Number of elements: 1 for simple elements and objects, Number of elements for arrays. This property is available in read-only.
Type	Integer	Type of element. This property is available in read-only.
Value	All types	Value of a simple element, NULL for a complex element.

Remark: These properties can be handled by using one of the following syntaxes:

<Variable name>..<Property name>
<Variable name>.<Property name>