# Struct ipworksiot::JSON

The JSON struct can be used to parse and write JSON documents.

## Syntax

```text
ipworksiot::JSON
```

## Remarks

The JSON struct offers a fast and simple way to parse and write information in JSON documents.

### Parsing JSON

The JSON struct parses JSON documents and verifies that they are well-formed. The results are provided through a set of events.

In addition, the document structure may be queried through an [xpath](#xpath-property-json-struct) mechanism that supports a subset of the XPath and JSONPath specification.

The parser is optimized for read applications, with a very fast engine that builds internal DOM structures with close to zero heap allocations. Additionally, [build_dom](#build_dom-property-json-struct) can be set to False, which reduces the overhead of creating the DOM and offers a fast forward-only parsing implementation that fires events to provide the parsed data.

When parsing a document, events will fire to provide information about the parsed data. After [parse](#parse-method-json-struct) returns the document, it may be navigated by setting [xpath](#xpath-property-json-struct) if [build_dom](#build_dom-property-json-struct) is True (default). If [build_dom](#build_dom-property-json-struct) is False, parsed data are accessible only through the events.

The following events will fire during parsing:

- [on_start_element](#on_start_element-event-json-struct)
- [on_characters](#on_characters-event-json-struct)
- [on_end_element](#on_end_element-event-json-struct)
- [on_ignorable_whitespace](#on_ignorable_whitespace-event-json-struct)

If [build_dom](#build_dom-property-json-struct) is True (default), [xpath](#xpath-property-json-struct) may be set after this method returns. [xpath](#xpath-property-json-struct) may be set to navigate to specific elements within the JSON document. This will be the path to a specified value within the document. Because arrays in JSON only contain values, and no associated object name, an empty name will be used for these values. To reach an array element at position 1, the path must be set to "[1]". In addition, a root element named "json" will be added to each JSON document in the parser.

[build_dom](#build_dom-property-json-struct) must be set to True before parsing the document for the [xpath](#xpath-property-json-struct) functionality to be available.

The [xpath](#xpath-property-json-struct) property accepts both XPath and JSONPath formats. Please review the following notes on both formats.

### XPath

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current [xpath](#xpath-property-json-struct) location.

 The following are possible values for an element accessor:

|  |  |
| --- | --- |
| 'name' | A particular element name. |
| [i] | The i-th subelement of the current element. |
| .. | the parent of the current element. |

 When [xpath](#xpath-property-json-struct) is set to a valid path, the following properties are updated:

- [xelement](#xelement-property-json-struct)
- [xelement_type](#xelement_type-property-json-struct)
- [xparent](#xparent-property-json-struct)
- [xtext](#xtext-property-json-struct)
- [xsub_tree](#xsub_tree-property-json-struct)
- xchildren

[build_dom](#build_dom-property-json-struct) must be set to True before parsing the document for the [xpath](#xpath-property-json-struct) functionality to be available.

**Simple JSON Document**

```text
{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}
```

 **Example 1. Setting XPath:**

|  |  |
| --- | --- |
| Document root | JsonControl.XPath = "/" |
| Specific Element | JsonControl.XPath = "/json/firstlevel/one/" |
| i-th Child | JsonControl.XPath = "/json/firstlevel/two/[i]/" |

 NOTE: When using XPath notation, the root element is always referred to as "json". As in the previous examples, this means all paths will begin with "/json".

### JSONPath

 This property implements a subset of the JSONPath notation. This may be set to point to a specific element in the JSON document.

The JSONPath is a series of one or more accessors in either dot-notation

```text
$.store.book[0].title
```

 or in bracket-notation, as follows:

```text
$['store']['book'][0]['title']
```

After setting [xpath](#xpath-property-json-struct), the following properties are populated:

- xchildren
- [xelement](#xelement-property-json-struct)
- [xelement_type](#xelement_type-property-json-struct)
- [xsub_tree](#xsub_tree-property-json-struct)
- [xtext](#xtext-property-json-struct)

 **Example 2. Setting JSONPath:**

Given the following JSON document:

```text
{
    "store": {
        "book": [
            {
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
                "price": 8.95
            },
            {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
                "price": 12.99
            },
            {
                "category": "fiction",
                "author": "Herman Melville",
                "title": "Moby Dick",
                "isbn": "0-553-21311-3",
                "price": 8.99
            },
            {
                "category": "fiction",
                "author": "J. R. R. Tolkien",
                "title": "The Lord of the Rings",
                "isbn": "0-395-19395-8",
                "price": 22.99
            }
        ],
        "bicycle": {
            "color": "red",
            "price": 19.95
        }
    },
}
```

 The following code shows several examples.

Get the first book's author:

```text
json.XPath = "$.store.book[0].author";
Console.WriteLine(json.XText);

//Output
//"Nigel Rees"
```

 Select the first book and inspect the children:

```text
json.XPath = "$.store.book[0]";
Console.WriteLine("Child Count: " + json.XChildren.Count);
Console.WriteLine(json.XChildren[1].Name + ": " + json.XChildren[1].XText);

//Output
//Child Count: 4
//author: "Nigel Rees"
```

 Get the price of the second book:

```text
json.XPath = "$['store']['book'][1]['price']";
Console.WriteLine(json.XText);

//Output
//12.99
```

 Get the second to last book's author:

```text
json.XPath = "$['store']['book'][last() - 1]['author']";
Console.WriteLine(json.XText);
Console.WriteLine(json.XPath); //Note that "last() - 1" is resolved to "3".

//Output
//"Herman Melville"
//$['store']['book'][3]['author']
```

 Display the full subtree at the current path:

```text
json.XPath = "$.store.book[0]";
Console.WriteLine(json.XSubTree);

//Output
//            {
//                "category": "reference",
//                "author": "Nigel Rees",
//                "title": "Sayings of the Century",
//                "price": 8.95
//            }
```

**Input Properties**

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-json-struct)
- [input_data](#input_data-property-json-struct)

 When a valid source is found, the search stops.

If parsing multiple documents, call [reset](#reset-method-json-struct) between documents to reset the parser.

### Writing JSON

The JSON struct also can be used to create a JSON document.

The document is written to the selected output property. In addition, as the document is written, the [on_json](#on_json-event-json-struct) event will fire. The *Text* event parameter contains the part of the document currently being written.

**Output Properties**

The struct will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-json-struct)
- [output_data](#output_data-property-json-struct): The output data are written to this property if no other destination is specified.

**Example. Writing a JSON Document:**

Writing a simple JSON document describing a pet:

```text
      Json json = new Json();
      json.OutputFile = "C:\\temp\\fido.json";
      json.StartObject();
      json.PutProperty("name", "fido", 2);
      json.PutName("previousOwners");
      json.StartArray();
      json.PutValue("Steve Widgetson", 2);
      json.PutValue("Wanda Widgetson", 2);
      json.PutValue("Randy Cooper", 2);
      json.PutValue("Linda Glover", 2);
      json.EndArray();
      json.PutProperty("weightUnit", "lbs", 2);
      json.PutProperty("weight", "62", 3);
      json.EndObject();
      json.Flush();
```

This example results in the following JSON:

```text
{
  "name": "fido",
  "previousOwners": [
    "Steve Widgetson",
    "Wanda Widgetson",
    "Randy Cooper",
    "Linda Glover"
  ],
  "weightUnit": "lbs",
  "weight": 62
}
```

When writing multiple documents, call [reset](#reset-method-json-struct) between documents to reset the writer.

### Modifying JSON

The JSON struct also allows for modifying existing JSON documents. After loading a JSON document with [parse](#parse-method-json-struct) the document may be edited. The struct supports inserting new values, renaming or overwriting existing values, and removing values. After editing is complete, call [save](#save-method-json-struct) to output the updated JSON document.

The following methods are applicable when modifying a JSON document:

- [insert_property](#insert_property-method-json-struct)
- [insert_value](#insert_value-method-json-struct)
- [remove](#remove-method-json-struct)
- [save](#save-method-json-struct)
- [set_name](#set_name-method-json-struct)
- [set_value](#set_value-method-json-struct)

When [save](#save-method-json-struct) is called, the modified JSON is written to the specified output location.

**Output Properties**

The struct will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-json-struct)
- [output_data](#output_data-property-json-struct): The output data are written to this property if no other destination is specified.

**Example 1. Inserting New Values:**

To insert new values in a JSON document, first load the existing document with [parse](#parse-method-json-struct). Next set [xpath](#xpath-property-json-struct) to the sibling or parent of the data to be inserted. Call [insert_property](#insert_property-method-json-struct) or [insert_value](#insert_value-method-json-struct) and pass the *ValueType* and *Position* parameters to indicate the type of data being inserted and the position.

The *ValueType* parameter of these methods specifies the type of the value. Possible values are as follows:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)

The *Position* parameter of these methods specifies the position of *Value*. Possible values are as follows:

- 0 (Before the current element)
- 1 (After the current element)
- 2 (The first child of the current element)
- 3 (The last child of the current element)

For example:

Given the following JSON:

```text
{
    "store": {
        "books": [
            {
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
            },
            {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
            }
        ]
    }
}
```

Insert a new property "price" for each book:

```csharp
json.XPath = "/json/store/books/[1]";
json.InsertProperty("price", "8.95", 3, 3);  //3 - Number, 3 - Last Child

json.XPath = "/json/store/books/[2]";
json.InsertProperty("price", "12.99", 3, 3); //3 - Number, 3 - Last Child

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "category": "reference",
      "author": "Nigel Rees",
      "title": "Sayings of the Century",
      "price": 8.95
    },
    {
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    }
    ]
  }
}
```

To add a new book to the array:

```csharp
json.XPath = "/json/store/books";
json.InsertValue("", 0, 3); //0 - Object, 3 - Last Child
json.XPath = "/json/store/books/[3]";
json.InsertProperty("category", "fiction", 2, 3);        //2 - String, 3 - Last Child
json.InsertProperty("author", "Herman Melville", 2, 3);  //2 - String, 3 - Last Child
json.InsertProperty("title", "Moby Dick", 2, 3);         //2 - String, 3 - Last Child
json.InsertProperty("price", "8.99", 3, 3);              //3 - Number, 3 - Last Child

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "category": "reference",
      "author": "Nigel Rees",
      "title": "Sayings of the Century",
      "price": 8.95
    },
    {
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    },
    {
      "category": "fiction",
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 8.99
    }
    ]
  }
}
```

To add a new array property to each book:

```csharp
json.XPath = "/json/store/books/[1]";
json.InsertProperty("tags", "", 1, 2); //1 - Array, 2 - First Child
json.XPath = "/json/store/books/[1]/tags";
json.InsertValue("quotes", 2, 3);      //2 - String, 3 - Last Child
json.InsertValue("british", 2, 3);     //2 - String, 3 - Last Child

json.XPath = "/json/store/books/[2]";
json.InsertProperty("tags", "", 1, 2); //1 - Array, 2 - First Child
json.XPath = "/json/store/books/[2]/tags";
json.InsertValue("trilogy", 2, 3);     //2 - String, 3 - Last Child
json.InsertValue("war", 2, 3);         //2 - String, 3 - Last Child

json.XPath = "/json/store/books/[3]";
json.InsertProperty("tags", "", 1, 2); //1 - Array, 2 - First Child
json.XPath = "/json/store/books/[3]/tags";
json.InsertValue("classic", 2, 3);     //2 - String, 3 - Last Child
json.InsertValue("whales", 2, 3);      //2 - String, 3 - Last Child

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "tags": ["quotes", "british"],
      "category": "reference",
      "author": "Nigel Rees",
      "title": "Sayings of the Century",
      "price": 8.95
    },
    {
      "tags": ["trilogy", "war"],
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    },
    {
      "tags": ["classic", "whales"],
      "category": "fiction",
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 8.99
    }
    ]
  }
}
```

**Example 2. Removing Values:**

To remove existing values, set [xpath](#xpath-property-json-struct) and call the [remove](#remove-method-json-struct) method. Continuing with example 1, to remove the first book:

```csharp
json.XPath = "/json/store/books/[1]";
json.Remove();

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "tags": ["trilogy", "war"],
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    },
    {
      "tags": ["classic", "whales"],
      "category": "fiction",
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 8.99
    }
    ]
  }
}
```

To remove the "category" properties from each book:

```csharp
json.XPath = "/json/store/books/[1]/category";
json.Remove();

json.XPath = "/json/store/books/[2]/category";
json.Remove();

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "tags": ["trilogy", "war"],
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    },
    {
      "tags": ["classic", "whales"],
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 8.99
    }
    ]
  }
}
```

**Example 3. Updating Existing Names and Values:**

The [set_name](#set_name-method-json-struct) and [set_value](#set_value-method-json-struct) methods may be used to modify existing names and values. Continuing with the preceding JSON in example 2, to rename "tags" to "meta" and update values within the array and prices:

```csharp
//Rename "tags" to "meta" for 1st book
json.XPath = "/json/store/books/[1]/tags";
json.SetName("meta");

//Update Price
json.XPath = "/json/store/books/[1]/price";
json.SetValue("13.99", 3); //3 - Number

//Rename "tags" to "meta" for 2nd book
json.XPath = "/json/store/books/[2]/tags";
json.SetName("meta");

//Update tag "whales" to "revenge"
json.XPath = "/json/store/books/[2]/meta/[2]";
json.SetValue("revenge", 2); //2 - String

//Update Price
json.XPath = "/json/store/books/[2]/price";
json.SetValue("9.99", 3); //3 - Number

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "meta": ["trilogy", "war"],
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 13.99
    },
    {
      "meta": ["classic", "revenge"],
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 9.99
    }
    ]
  }
}
```

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksIoT. Due to this, the JSON struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of JSON when you have finished using the instance.

## Property List

*The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [build_dom](#build_dom-property-json-struct) | When True, an internal object model of the JSON document is created. |
| [input_data](#input_data-property-json-struct) | This property includes the JSON data to parse. |
| [input_file](#input_file-property-json-struct) | This property specifies the file to process. |
| [output_data](#output_data-property-json-struct) | This property includes the output JSON after processing. |
| [output_file](#output_file-property-json-struct) | This is the path to a local file where the output will be written. |
| [overwrite](#overwrite-property-json-struct) | This property indicates whether or not the struct should overwrite files. |
| [validate](#validate-property-json-struct) | This property controls whether documents are validated during parsing. |
| [xchild_count](#xchild_count-property-json-struct) | The number of records in the XChild arrays. |
| [xchild_element_type](#xchild_element_type-property-json-struct) | The ElementType property indicates the data type of the element. |
| [xchild_name](#xchild_name-property-json-struct) | The Name property provides the name of the element. |
| [xchild_x_text](#xchild_x_text-property-json-struct) | This property contains the text of the element. |
| [xelement](#xelement-property-json-struct) | This property includes the name of the current element. |
| [xelement_type](#xelement_type-property-json-struct) | This property indicates the data type of the current element. |
| [xerror_path](#xerror_path-property-json-struct) | This property includes an XPath to check the server response for errors. |
| [xparent](#xparent-property-json-struct) | The parent of the current element. |
| [xpath](#xpath-property-json-struct) | This property provides a way to point to a specific element in the response. |
| [xsub_tree](#xsub_tree-property-json-struct) | This property includes a snapshot of the current element in the document. |
| [xtext](#xtext-property-json-struct) | This property includes the text of the current element. |

## Method List

*The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [config](#config-method-json-struct) | Sets or retrieves a configuration setting. |
| [end_array](#end_array-method-json-struct) | This method writes the closing bracket of a JSON array. |
| [end_object](#end_object-method-json-struct) | This method writes the closing brace of a JSON object. |
| [flush](#flush-method-json-struct) | This method flushes the parser's or writer's buffers. |
| [has_xpath](#has_xpath-method-json-struct) | This method determines whether a specific element exists in the document. |
| [insert_property](#insert_property-method-json-struct) | This method inserts the specified name and value at the selected position. |
| [insert_value](#insert_value-method-json-struct) | This method inserts the specified value at the selected position. |
| [parse](#parse-method-json-struct) | This method parses the specified JSON data. |
| [put_name](#put_name-method-json-struct) | This method writes the name of a property. |
| [put_property](#put_property-method-json-struct) | This method writes a property and value. |
| [put_raw](#put_raw-method-json-struct) | This method writes a raw JSON fragment. |
| [put_value](#put_value-method-json-struct) | This method writes a value of a property. |
| [remove](#remove-method-json-struct) | This method removes the element or value set in XPath. |
| [reset](#reset-method-json-struct) | This method resets the struct. |
| [save](#save-method-json-struct) | This method saves the modified JSON document. |
| [set_name](#set_name-method-json-struct) | This method sets a new name for the element specified by XPath. |
| [set_value](#set_value-method-json-struct) | This method sets a new value for the element specified by XPath. |
| [start_array](#start_array-method-json-struct) | This method writes the opening bracket of a JSON array. |
| [start_object](#start_object-method-json-struct) | This event writes the opening brace of a JSON object. |
| [try_xpath](#try_xpath-method-json-struct) | This method navigates to the specified XPath if it exists. |

## Event List

*The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [on_characters](#on_characters-event-json-struct) | This event is fired for plaintext segments of the input stream. |
| [on_end_document](#on_end_document-event-json-struct) | This event fires when the end of a JSON document is encountered. |
| [on_end_element](#on_end_element-event-json-struct) | This event is fired when an end-element tag is encountered. |
| [on_error](#on_error-event-json-struct) | Fired when information is available about errors during data delivery. |
| [on_ignorable_whitespace](#on_ignorable_whitespace-event-json-struct) | This event is fired when a section of ignorable whitespace is encountered. |
| [on_json](#on_json-event-json-struct) | This event fires with the JSON data being written. |
| [on_start_document](#on_start_document-event-json-struct) | This event fires when the start of a new JSON document is encountered. |
| [on_start_element](#on_start_element-event-json-struct) | This event is fired when a new element is encountered in the document. |

## Config Settings

*The following is a list of config settings for the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [CacheContent](#CacheContent) | If true, the original JSON is stored internally in a buffer. |
| [ElementXPath](#ElementXPath) | The XPath value for the current element in the document. |
| [EscapeForwardSlashes](#EscapeForwardSlashes) | Whether to escape forward slashes when writing a JSON object. |
| [InputFormat](#InputFormat) | Specifies the input format used in JSON streaming. |
| [PrettyPrint](#PrettyPrint) | Determines whether output is on one line or "pretty printed". |
| [RecordEndDelimiter](#RecordEndDelimiter) | The character sequence after the end of a JSON document. |
| [RecordStartDelimiter](#RecordStartDelimiter) | The character sequence before the start of a JSON document. |
| [StringProcessingOptions](#StringProcessingOptions) | Defines options to use when processing string values. |
| [XPathNotation](#XPathNotation) | Specifies the expected format when setting XPath. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# build_dom property ([JSON](#struct-ipworksiotjson) Struct)

When True, an internal object model of the JSON document is created.

## Syntax

*Rust Syntax*

```text
fn build_dom(&self ) -> Result<bool, IPWorksIoTError> fn set_build_dom(&self, value : bool) ->  Option<IPWorksIoTError>
```

## Default Value

true

## Remarks

Set this property to True when you need to browse the current document through [xpath](#xpath-property-json-struct).

## Data Type

bool

# input_data property ([JSON](#struct-ipworksiotjson) Struct)

This property includes the JSON data to parse.

## Syntax

*Rust Syntax*

```text
fn input_data(&self ) -> Result<String, IPWorksIoTError> fn set_input_data(&self, value : &str) ->  Option<IPWorksIoTError>
fn set_input_data_ref(&self, value : &String) ->  Option<IPWorksIoTError>
```

## Default Value

""

## Remarks

This property specifies the JSON to be processed. Set this property before calling [parse](#parse-method-json-struct).

This may be set to a complete JSON document, or partial data. When setting partial data, call [parse](#parse-method-json-struct) after each chunk of data is set. For instance:

```text
//Parse the following in chunks: { "data": 1}
json.InputData = "{ \"data\""
json.Parse();
json.InputData = ": 1}"
json.Parse();
```

**Input Properties**

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-json-struct)
- input_data

 When a valid source is found, the search stops.

## Data Type

String

# input_file property ([JSON](#struct-ipworksiotjson) Struct)

This property specifies the file to process.

## Syntax

*Rust Syntax*

```text
fn input_file(&self ) -> Result<String, IPWorksIoTError> fn set_input_file(&self, value : &str) ->  Option<IPWorksIoTError>
fn set_input_file_ref(&self, value : &String) ->  Option<IPWorksIoTError>
```

## Default Value

""

## Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file that will be processed.

After setting this property, call [parse](#parse-method-json-struct) to parse the document.

**Input Properties**

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

- input_file
- [input_data](#input_data-property-json-struct)

 When a valid source is found, the search stops.

## Data Type

String

# output_data property ([JSON](#struct-ipworksiotjson) Struct)

This property includes the output JSON after processing.

## Syntax

*Rust Syntax*

```text
fn output_data(&self ) -> Result<String, IPWorksIoTError> fn set_output_data(&self, value : &str) ->  Option<IPWorksIoTError>
fn set_output_data_ref(&self, value : &String) ->  Option<IPWorksIoTError>
```

## Default Value

""

## Remarks

This property contains the resultant JSON after processing.

**Output Properties**

The struct will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-json-struct)
- output_data: The output data are written to this property if no other destination is specified.

## Data Type

String

# output_file property ([JSON](#struct-ipworksiotjson) Struct)

This is the path to a local file where the output will be written.

## Syntax

*Rust Syntax*

```text
fn output_file(&self ) -> Result<String, IPWorksIoTError> fn set_output_file(&self, value : &str) ->  Option<IPWorksIoTError>
fn set_output_file_ref(&self, value : &String) ->  Option<IPWorksIoTError>
```

## Default Value

""

## Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

**Output Properties**

The struct will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

- output_file
- [output_data](#output_data-property-json-struct): The output data are written to this property if no other destination is specified.

## Data Type

String

# overwrite property ([JSON](#struct-ipworksiotjson) Struct)

This property indicates whether or not the struct should overwrite files.

## Syntax

*Rust Syntax*

```text
fn overwrite(&self ) -> Result<bool, IPWorksIoTError> fn set_overwrite(&self, value : bool) ->  Option<IPWorksIoTError>
```

## Default Value

false

## Remarks

This property indicates whether or not the struct will overwrite [output_file](#output_file-property-json-struct). If overwrite is False, an error will be thrown whenever [output_file](#output_file-property-json-struct) exists before an operation. The default value is False.

## Data Type

bool

# validate property ([JSON](#struct-ipworksiotjson) Struct)

This property controls whether documents are validated during parsing.

## Syntax

*Rust Syntax*

```text
fn validate(&self ) -> Result<bool, IPWorksIoTError> fn set_validate(&self, value : bool) ->  Option<IPWorksIoTError>
```

## Default Value

true

## Remarks

When *true* (default), the document will be validated during parsing. To disable validation set validate to *false*. Disabling validation may be useful in cases in which data can still be parsed even if the document is not well formed.

## Data Type

bool

# xchild_count property ([JSON](#struct-ipworksiotjson) Struct)

The number of records in the XChild arrays.

## Syntax

*Rust Syntax*

```text
fn xchild_count(&self ) -> Result<i32, IPWorksIoTError> fn set_xchild_count(&self, value : i32) ->  Option<IPWorksIoTError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [xchild_element_type](#xchild_element_type-property-json-struct)
- [xchild_name](#xchild_name-property-json-struct)
- [xchild_x_text](#xchild_x_text-property-json-struct)

The array indices start at *0* and end at *xchild_count - 1*.

## Data Type

i32

# xchild_element_type property ([JSON](#struct-ipworksiotjson) Struct)

The ElementType property indicates the data type of the element.

## Syntax

*Rust Syntax*

```text
fn xchild_element_type(&self , XChildIndex : i32) -> Result<i32, IPWorksIoTError>
```

## Possible Values

```text
0   // Object1   // Array2   // String3   // Number4   // Bool5   // Null
```

## Default Value

0

## Remarks

The [xchild_element_type](#xchild_element_type-property-json-struct) property indicates the data type of the element.

Possible values are as follows:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)

The *XChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [XChildCount](#xchild_count-property-json-struct) property.

This property is read-only.

## Data Type

i32

# xchild_name property ([JSON](#struct-ipworksiotjson) Struct)

The Name property provides the name of the element.

## Syntax

*Rust Syntax*

```text
fn xchild_name(&self , XChildIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

The [xchild_name](#xchild_name-property-json-struct) property provides the name of the element. For elements within an array, the [xchild_name](#xchild_name-property-json-struct) property will be empty.

The *XChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [XChildCount](#xchild_count-property-json-struct) property.

This property is read-only.

## Data Type

String

# xchild_x_text property ([JSON](#struct-ipworksiotjson) Struct)

This property contains the text of the element.

## Syntax

*Rust Syntax*

```text
fn xchild_x_text(&self , XChildIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

This property contains the text of the element.

The *XChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [XChildCount](#xchild_count-property-json-struct) property.

This property is read-only.

## Data Type

String

# xelement property ([JSON](#struct-ipworksiotjson) Struct)

This property includes the name of the current element.

## Syntax

*Rust Syntax*

```text
fn xelement(&self ) -> Result<String, IPWorksIoTError> fn set_xelement(&self, value : &str) ->  Option<IPWorksIoTError>
fn set_xelement_ref(&self, value : &String) ->  Option<IPWorksIoTError>
```

## Default Value

""

## Remarks

This property contains the name of the current element. The current element is specified through the [xpath](#xpath-property-json-struct) property.

## Data Type

String

# xelement_type property ([JSON](#struct-ipworksiotjson) Struct)

This property indicates the data type of the current element.

## Syntax

*Rust Syntax*

```text
fn xelement_type(&self ) -> Result<i32, IPWorksIoTError>
```

## Possible Values

```text
0   // Object1   // Array2   // String3   // Number4   // Bool5   // Null
```

## Default Value

0

## Remarks

This property specifies the data type of the current element. After setting [xpath](#xpath-property-json-struct), this property is populated. Possible values are as follows:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)

NOTE: This property is not applicable when parsing a document and [build_dom](#build_dom-property-json-struct) is False.

This property is read-only.

## Data Type

i32

# xerror_path property ([JSON](#struct-ipworksiotjson) Struct)

This property includes an XPath to check the server response for errors.

## Syntax

*Rust Syntax*

```text
fn xerror_path(&self ) -> Result<String, IPWorksIoTError> fn set_xerror_path(&self, value : &str) ->  Option<IPWorksIoTError>
fn set_xerror_path_ref(&self, value : &String) ->  Option<IPWorksIoTError>
```

## Default Value

""

## Remarks

This property contains an XPath to check the server response for errors. If the XPath exists, an exception will be thrown containing the value of the element at the path.

## Data Type

String

# xparent property ([JSON](#struct-ipworksiotjson) Struct)

The parent of the current element.

## Syntax

*Rust Syntax*

```text
fn xparent(&self ) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

This property contains the parent of the current element. The current element is specified via the [xpath](#xpath-property-json-struct) property.

This property is read-only.

## Data Type

String

# xpath property ([JSON](#struct-ipworksiotjson) Struct)

This property provides a way to point to a specific element in the response.

## Syntax

*Rust Syntax*

```text
fn xpath(&self ) -> Result<String, IPWorksIoTError> fn set_xpath(&self, value : &str) ->  Option<IPWorksIoTError>
fn set_xpath_ref(&self, value : &String) ->  Option<IPWorksIoTError>
```

## Default Value

""

## Remarks

xpath may be set to navigate to specific elements within the JSON document. This will be the path to a specified value within the document. Because arrays in JSON only contain values, and no associated object name, an empty name will be used for these values. To reach an array element at position 1, the path must be set to "[1]". In addition, a root element named "json" will be added to each JSON document in the parser.

[build_dom](#build_dom-property-json-struct) must be set to True before parsing the document for the xpath functionality to be available.

The xpath property accepts both XPath and JSONPath formats. Please review the following notes on both formats.

### XPath

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current xpath location.

 The following are possible values for an element accessor:

|  |  |
| --- | --- |
| 'name' | A particular element name. |
| [i] | The i-th subelement of the current element. |
| .. | the parent of the current element. |

 When xpath is set to a valid path, the following properties are updated:

- [xelement](#xelement-property-json-struct)
- [xelement_type](#xelement_type-property-json-struct)
- [xparent](#xparent-property-json-struct)
- [xtext](#xtext-property-json-struct)
- [xsub_tree](#xsub_tree-property-json-struct)
- xchildren

[build_dom](#build_dom-property-json-struct) must be set to True before parsing the document for the xpath functionality to be available.

**Simple JSON Document**

```text
{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}
```

 **Example 1. Setting XPath:**

|  |  |
| --- | --- |
| Document root | JsonControl.XPath = "/" |
| Specific Element | JsonControl.XPath = "/json/firstlevel/one/" |
| i-th Child | JsonControl.XPath = "/json/firstlevel/two/[i]/" |

 NOTE: When using XPath notation, the root element is always referred to as "json". As in the previous examples, this means all paths will begin with "/json".

### JSONPath

 This property implements a subset of the JSONPath notation. This may be set to point to a specific element in the JSON document.

The JSONPath is a series of one or more accessors in either dot-notation

```text
$.store.book[0].title
```

 or in bracket-notation, as follows:

```text
$['store']['book'][0]['title']
```

After setting xpath, the following properties are populated:

- xchildren
- [xelement](#xelement-property-json-struct)
- [xelement_type](#xelement_type-property-json-struct)
- [xsub_tree](#xsub_tree-property-json-struct)
- [xtext](#xtext-property-json-struct)

 **Example 2. Setting JSONPath:**

Given the following JSON document:

```text
{
    "store": {
        "book": [
            {
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
                "price": 8.95
            },
            {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
                "price": 12.99
            },
            {
                "category": "fiction",
                "author": "Herman Melville",
                "title": "Moby Dick",
                "isbn": "0-553-21311-3",
                "price": 8.99
            },
            {
                "category": "fiction",
                "author": "J. R. R. Tolkien",
                "title": "The Lord of the Rings",
                "isbn": "0-395-19395-8",
                "price": 22.99
            }
        ],
        "bicycle": {
            "color": "red",
            "price": 19.95
        }
    },
}
```

 The following code shows several examples.

Get the first book's author:

```text
json.XPath = "$.store.book[0].author";
Console.WriteLine(json.XText);

//Output
//"Nigel Rees"
```

 Select the first book and inspect the children:

```text
json.XPath = "$.store.book[0]";
Console.WriteLine("Child Count: " + json.XChildren.Count);
Console.WriteLine(json.XChildren[1].Name + ": " + json.XChildren[1].XText);

//Output
//Child Count: 4
//author: "Nigel Rees"
```

 Get the price of the second book:

```text
json.XPath = "$['store']['book'][1]['price']";
Console.WriteLine(json.XText);

//Output
//12.99
```

 Get the second to last book's author:

```text
json.XPath = "$['store']['book'][last() - 1]['author']";
Console.WriteLine(json.XText);
Console.WriteLine(json.XPath); //Note that "last() - 1" is resolved to "3".

//Output
//"Herman Melville"
//$['store']['book'][3]['author']
```

 Display the full subtree at the current path:

```text
json.XPath = "$.store.book[0]";
Console.WriteLine(json.XSubTree);

//Output
//            {
//                "category": "reference",
//                "author": "Nigel Rees",
//                "title": "Sayings of the Century",
//                "price": 8.95
//            }
```

## Data Type

String

# xsub_tree property ([JSON](#struct-ipworksiotjson) Struct)

This property includes a snapshot of the current element in the document.

## Syntax

*Rust Syntax*

```text
fn xsub_tree(&self ) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

The current element is specified through this property. For this property to work, you must have the [CacheContent](#CacheContent) set to True.

This property is read-only.

## Data Type

String

# xtext property ([JSON](#struct-ipworksiotjson) Struct)

This property includes the text of the current element.

## Syntax

*Rust Syntax*

```text
fn xtext(&self ) -> Result<String, IPWorksIoTError> fn set_xtext(&self, value : &str) ->  Option<IPWorksIoTError>
fn set_xtext_ref(&self, value : &String) ->  Option<IPWorksIoTError>
```

## Default Value

""

## Remarks

This property contains the text of the current element. The current element is specified through the [xpath](#xpath-property-json-struct) property.

## Data Type

String

# config method ([JSON](#struct-ipworksiotjson) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksIoTError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-json-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-json-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# end_array method ([JSON](#struct-ipworksiotjson) Struct)

This method writes the closing bracket of a JSON array.

## Syntax

*Rust Syntax*

```text
fn end_array(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method writes the closing bracket of a JSON array to the output. An array must already have been opened by calling [start_array](#start_array-method-json-struct).

# end_object method ([JSON](#struct-ipworksiotjson) Struct)

This method writes the closing brace of a JSON object.

## Syntax

*Rust Syntax*

```text
fn end_object(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method writes the closing brace of a JSON object. An object must have been started previously by calling [start_object](#start_object-method-json-struct).

# flush method ([JSON](#struct-ipworksiotjson) Struct)

This method flushes the parser's or writer's buffers.

## Syntax

*Rust Syntax*

```text
fn flush(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

When flush is called, the component flushes all of its buffers, firing events as necessary.

When parsing, the end state of the JSON is checked. If [validate](#validate-property-json-struct) is also True, the parser verifies that all open elements were closed, returning an error if not.

When writing, the resultant JSON is available in one of the output properties.

**Output Properties**

The struct will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-json-struct)
- [output_data](#output_data-property-json-struct): The output data are written to this property if no other destination is specified.

# has_xpath method ([JSON](#struct-ipworksiotjson) Struct)

This method determines whether a specific element exists in the document.

## Syntax

*Rust Syntax*

```text
fn has_xpath(&self, xpath : &str) ->  Result<bool, IPWorksIoTError>
```

## Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through [xpath](#xpath-property-json-struct).

This method returns *true* if the *xpath* exists, and *false* if not.

See [xpath](#xpath-property-json-struct) for details on the XPath syntax.

# insert_property method ([JSON](#struct-ipworksiotjson) Struct)

This method inserts the specified name and value at the selected position.

## Syntax

*Rust Syntax*

```text
fn insert_property(&self, name : &str, value : &str, value_type : i32, position : i32) -> Result<(), IPWorksIoTError>
```

## Remarks

This method inserts a property and its corresponding value relative to the element specified by [xpath](#xpath-property-json-struct). Before calling this method, a valid JSON document must first be loaded by calling [parse](#parse-method-json-struct).

The *name* parameter specifies the name of the property.

The *value* parameter specifies the value of the property.

The *value_type* parameter specifies the type of the value. Possible values are as follows:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)

The *position* parameter specifies the position of *value* relative to the element specified by [xpath](#xpath-property-json-struct). Possible values are as follows:

- 0 (Before the current element)
- 1 (After the current element)
- 2 (The first child of the current element)
- 3 (The last child of the current element)

See [save](#save-method-json-struct) for details.

# insert_value method ([JSON](#struct-ipworksiotjson) Struct)

This method inserts the specified value at the selected position.

## Syntax

*Rust Syntax*

```text
fn insert_value(&self, value : &str, value_type : i32, position : i32) -> Result<(), IPWorksIoTError>
```

## Remarks

This method inserts a value relative to the element specified by [xpath](#xpath-property-json-struct). Before calling this method, a valid JSON document must first be loaded by calling [parse](#parse-method-json-struct).

The *value* parameter specifies the value of the property.

The *value_type* parameter specifies the type of the value. Possible values are as follows:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)

The *position* parameter specifies the position of *value* relative to the element specified by [xpath](#xpath-property-json-struct). Possible values are as follows:

- 0 (Before the current element)
- 1 (After the current element)
- 2 (The first child of the current element)
- 3 (The last child of the current element)

See [save](#save-method-json-struct) for details.

# parse method ([JSON](#struct-ipworksiotjson) Struct)

This method parses the specified JSON data.

## Syntax

*Rust Syntax*

```text
fn parse(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method parses the specified JSON data.

When parsing a document, events will fire to provide information about the parsed data. After parse returns the document, it may be navigated by setting [xpath](#xpath-property-json-struct) if [build_dom](#build_dom-property-json-struct) is True (default). If [build_dom](#build_dom-property-json-struct) is False, parsed data are accessible only through the events.

The following events will fire during parsing:

- [on_start_element](#on_start_element-event-json-struct)
- [on_characters](#on_characters-event-json-struct)
- [on_end_element](#on_end_element-event-json-struct)
- [on_ignorable_whitespace](#on_ignorable_whitespace-event-json-struct)

If [build_dom](#build_dom-property-json-struct) is True (default), [xpath](#xpath-property-json-struct) may be set after this method returns. [xpath](#xpath-property-json-struct) may be set to navigate to specific elements within the JSON document. This will be the path to a specified value within the document. Because arrays in JSON only contain values, and no associated object name, an empty name will be used for these values. To reach an array element at position 1, the path must be set to "[1]". In addition, a root element named "json" will be added to each JSON document in the parser.

[build_dom](#build_dom-property-json-struct) must be set to True before parsing the document for the [xpath](#xpath-property-json-struct) functionality to be available.

The [xpath](#xpath-property-json-struct) property accepts both XPath and JSONPath formats. Please review the following notes on both formats.

### XPath

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current [xpath](#xpath-property-json-struct) location.

 The following are possible values for an element accessor:

|  |  |
| --- | --- |
| 'name' | A particular element name. |
| [i] | The i-th subelement of the current element. |
| .. | the parent of the current element. |

 When [xpath](#xpath-property-json-struct) is set to a valid path, the following properties are updated:

- [xelement](#xelement-property-json-struct)
- [xelement_type](#xelement_type-property-json-struct)
- [xparent](#xparent-property-json-struct)
- [xtext](#xtext-property-json-struct)
- [xsub_tree](#xsub_tree-property-json-struct)
- xchildren

[build_dom](#build_dom-property-json-struct) must be set to True before parsing the document for the [xpath](#xpath-property-json-struct) functionality to be available.

**Simple JSON Document**

```text
{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}
```

 **Example 1. Setting XPath:**

|  |  |
| --- | --- |
| Document root | JsonControl.XPath = "/" |
| Specific Element | JsonControl.XPath = "/json/firstlevel/one/" |
| i-th Child | JsonControl.XPath = "/json/firstlevel/two/[i]/" |

 NOTE: When using XPath notation, the root element is always referred to as "json". As in the previous examples, this means all paths will begin with "/json".

### JSONPath

 This property implements a subset of the JSONPath notation. This may be set to point to a specific element in the JSON document.

The JSONPath is a series of one or more accessors in either dot-notation

```text
$.store.book[0].title
```

 or in bracket-notation, as follows:

```text
$['store']['book'][0]['title']
```

After setting [xpath](#xpath-property-json-struct), the following properties are populated:

- xchildren
- [xelement](#xelement-property-json-struct)
- [xelement_type](#xelement_type-property-json-struct)
- [xsub_tree](#xsub_tree-property-json-struct)
- [xtext](#xtext-property-json-struct)

 **Example 2. Setting JSONPath:**

Given the following JSON document:

```text
{
    "store": {
        "book": [
            {
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
                "price": 8.95
            },
            {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
                "price": 12.99
            },
            {
                "category": "fiction",
                "author": "Herman Melville",
                "title": "Moby Dick",
                "isbn": "0-553-21311-3",
                "price": 8.99
            },
            {
                "category": "fiction",
                "author": "J. R. R. Tolkien",
                "title": "The Lord of the Rings",
                "isbn": "0-395-19395-8",
                "price": 22.99
            }
        ],
        "bicycle": {
            "color": "red",
            "price": 19.95
        }
    },
}
```

 The following code shows several examples.

Get the first book's author:

```text
json.XPath = "$.store.book[0].author";
Console.WriteLine(json.XText);

//Output
//"Nigel Rees"
```

 Select the first book and inspect the children:

```text
json.XPath = "$.store.book[0]";
Console.WriteLine("Child Count: " + json.XChildren.Count);
Console.WriteLine(json.XChildren[1].Name + ": " + json.XChildren[1].XText);

//Output
//Child Count: 4
//author: "Nigel Rees"
```

 Get the price of the second book:

```text
json.XPath = "$['store']['book'][1]['price']";
Console.WriteLine(json.XText);

//Output
//12.99
```

 Get the second to last book's author:

```text
json.XPath = "$['store']['book'][last() - 1]['author']";
Console.WriteLine(json.XText);
Console.WriteLine(json.XPath); //Note that "last() - 1" is resolved to "3".

//Output
//"Herman Melville"
//$['store']['book'][3]['author']
```

 Display the full subtree at the current path:

```text
json.XPath = "$.store.book[0]";
Console.WriteLine(json.XSubTree);

//Output
//            {
//                "category": "reference",
//                "author": "Nigel Rees",
//                "title": "Sayings of the Century",
//                "price": 8.95
//            }
```

**Input Properties**

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-json-struct)
- [input_data](#input_data-property-json-struct)

 When a valid source is found, the search stops.

If parsing multiple documents, call [reset](#reset-method-json-struct) between documents to reset the parser.

# put_name method ([JSON](#struct-ipworksiotjson) Struct)

This method writes the name of a property.

## Syntax

*Rust Syntax*

```text
fn put_name(&self, name : &str) -> Result<(), IPWorksIoTError>
```

## Remarks

This method writes the name of a property. The *name* parameter specifies the value to write.

# put_property method ([JSON](#struct-ipworksiotjson) Struct)

This method writes a property and value.

## Syntax

*Rust Syntax*

```text
fn put_property(&self, name : &str, value : &str, value_type : i32) -> Result<(), IPWorksIoTError>
```

## Remarks

This method writes a property and its corresponding value to the output.

The *name* parameter specifies the name of the property.

The *value* parameter specifies the value of the property.

The *value_type* parameter specifies the type of the value. Possible values are as follows:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)

# put_raw method ([JSON](#struct-ipworksiotjson) Struct)

This method writes a raw JSON fragment.

## Syntax

*Rust Syntax*

```text
fn put_raw(&self, text : &str) -> Result<(), IPWorksIoTError>
```

## Remarks

This method writes raw data to the output. This may be used to write any data of any format directly to the output.

# put_value method ([JSON](#struct-ipworksiotjson) Struct)

This method writes a value of a property.

## Syntax

*Rust Syntax*

```text
fn put_value(&self, value : &str, value_type : i32) -> Result<(), IPWorksIoTError>
```

## Remarks

This method writes the value of a property to the output. The *value* parameter specifies the value. The *value_type* parameter specifies the type of data. Possible values are as follows:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)

# remove method ([JSON](#struct-ipworksiotjson) Struct)

This method removes the element or value set in XPath.

## Syntax

*Rust Syntax*

```text
fn remove(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method removes the current object at the specified [xpath](#xpath-property-json-struct). This is used when editing previously loaded JSON documents.

See [save](#save-method-json-struct) for details.

# reset method ([JSON](#struct-ipworksiotjson) Struct)

This method resets the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method resets the JSON parser.

# save method ([JSON](#struct-ipworksiotjson) Struct)

This method saves the modified JSON document.

## Syntax

*Rust Syntax*

```text
fn save(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method saves the modified JSON data. This is used after editing a previously loaded JSON document.

After loading a JSON document with [parse](#parse-method-json-struct) the document may be edited. The struct supports inserting new values, renaming or overwriting existing values, and removing values. After editing is complete, call save to output the updated JSON document.

The following methods are applicable when modifying a JSON document:

- [insert_property](#insert_property-method-json-struct)
- [insert_value](#insert_value-method-json-struct)
- [remove](#remove-method-json-struct)
- save
- [set_name](#set_name-method-json-struct)
- [set_value](#set_value-method-json-struct)

When save is called, the modified JSON is written to the specified output location.

**Output Properties**

The struct will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-json-struct)
- [output_data](#output_data-property-json-struct): The output data are written to this property if no other destination is specified.

**Example 1. Inserting New Values:**

To insert new values in a JSON document, first load the existing document with [parse](#parse-method-json-struct). Next set [xpath](#xpath-property-json-struct) to the sibling or parent of the data to be inserted. Call [insert_property](#insert_property-method-json-struct) or [insert_value](#insert_value-method-json-struct) and pass the *ValueType* and *Position* parameters to indicate the type of data being inserted and the position.

The *ValueType* parameter of these methods specifies the type of the value. Possible values are as follows:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)

The *Position* parameter of these methods specifies the position of *Value*. Possible values are as follows:

- 0 (Before the current element)
- 1 (After the current element)
- 2 (The first child of the current element)
- 3 (The last child of the current element)

For example:

Given the following JSON:

```text
{
    "store": {
        "books": [
            {
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
            },
            {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
            }
        ]
    }
}
```

Insert a new property "price" for each book:

```csharp
json.XPath = "/json/store/books/[1]";
json.InsertProperty("price", "8.95", 3, 3);  //3 - Number, 3 - Last Child

json.XPath = "/json/store/books/[2]";
json.InsertProperty("price", "12.99", 3, 3); //3 - Number, 3 - Last Child

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "category": "reference",
      "author": "Nigel Rees",
      "title": "Sayings of the Century",
      "price": 8.95
    },
    {
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    }
    ]
  }
}
```

To add a new book to the array:

```csharp
json.XPath = "/json/store/books";
json.InsertValue("", 0, 3); //0 - Object, 3 - Last Child
json.XPath = "/json/store/books/[3]";
json.InsertProperty("category", "fiction", 2, 3);        //2 - String, 3 - Last Child
json.InsertProperty("author", "Herman Melville", 2, 3);  //2 - String, 3 - Last Child
json.InsertProperty("title", "Moby Dick", 2, 3);         //2 - String, 3 - Last Child
json.InsertProperty("price", "8.99", 3, 3);              //3 - Number, 3 - Last Child

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "category": "reference",
      "author": "Nigel Rees",
      "title": "Sayings of the Century",
      "price": 8.95
    },
    {
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    },
    {
      "category": "fiction",
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 8.99
    }
    ]
  }
}
```

To add a new array property to each book:

```csharp
json.XPath = "/json/store/books/[1]";
json.InsertProperty("tags", "", 1, 2); //1 - Array, 2 - First Child
json.XPath = "/json/store/books/[1]/tags";
json.InsertValue("quotes", 2, 3);      //2 - String, 3 - Last Child
json.InsertValue("british", 2, 3);     //2 - String, 3 - Last Child

json.XPath = "/json/store/books/[2]";
json.InsertProperty("tags", "", 1, 2); //1 - Array, 2 - First Child
json.XPath = "/json/store/books/[2]/tags";
json.InsertValue("trilogy", 2, 3);     //2 - String, 3 - Last Child
json.InsertValue("war", 2, 3);         //2 - String, 3 - Last Child

json.XPath = "/json/store/books/[3]";
json.InsertProperty("tags", "", 1, 2); //1 - Array, 2 - First Child
json.XPath = "/json/store/books/[3]/tags";
json.InsertValue("classic", 2, 3);     //2 - String, 3 - Last Child
json.InsertValue("whales", 2, 3);      //2 - String, 3 - Last Child

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "tags": ["quotes", "british"],
      "category": "reference",
      "author": "Nigel Rees",
      "title": "Sayings of the Century",
      "price": 8.95
    },
    {
      "tags": ["trilogy", "war"],
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    },
    {
      "tags": ["classic", "whales"],
      "category": "fiction",
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 8.99
    }
    ]
  }
}
```

**Example 2. Removing Values:**

To remove existing values, set [xpath](#xpath-property-json-struct) and call the [remove](#remove-method-json-struct) method. Continuing with example 1, to remove the first book:

```csharp
json.XPath = "/json/store/books/[1]";
json.Remove();

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "tags": ["trilogy", "war"],
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    },
    {
      "tags": ["classic", "whales"],
      "category": "fiction",
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 8.99
    }
    ]
  }
}
```

To remove the "category" properties from each book:

```csharp
json.XPath = "/json/store/books/[1]/category";
json.Remove();

json.XPath = "/json/store/books/[2]/category";
json.Remove();

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "tags": ["trilogy", "war"],
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99
    },
    {
      "tags": ["classic", "whales"],
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 8.99
    }
    ]
  }
}
```

**Example 3. Updating Existing Names and Values:**

The [set_name](#set_name-method-json-struct) and [set_value](#set_value-method-json-struct) methods may be used to modify existing names and values. Continuing with the preceding JSON in example 2, to rename "tags" to "meta" and update values within the array and prices:

```csharp
//Rename "tags" to "meta" for 1st book
json.XPath = "/json/store/books/[1]/tags";
json.SetName("meta");

//Update Price
json.XPath = "/json/store/books/[1]/price";
json.SetValue("13.99", 3); //3 - Number

//Rename "tags" to "meta" for 2nd book
json.XPath = "/json/store/books/[2]/tags";
json.SetName("meta");

//Update tag "whales" to "revenge"
json.XPath = "/json/store/books/[2]/meta/[2]";
json.SetValue("revenge", 2); //2 - String

//Update Price
json.XPath = "/json/store/books/[2]/price";
json.SetValue("9.99", 3); //3 - Number

json.Save();
```

Produces the JSON:

```text
{
  "store": {
    "books": [
    {
      "meta": ["trilogy", "war"],
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 13.99
    },
    {
      "meta": ["classic", "revenge"],
      "author": "Herman Melville",
      "title": "Moby Dick",
      "price": 9.99
    }
    ]
  }
}
```

# set_name method ([JSON](#struct-ipworksiotjson) Struct)

This method sets a new name for the element specified by XPath.

## Syntax

*Rust Syntax*

```text
fn set_name(&self, name : &str) -> Result<(), IPWorksIoTError>
```

## Remarks

This method sets a new name for the element specified in [xpath](#xpath-property-json-struct). This is used to modify an existing JSON document.

The *name* parameter specifies the new name of the element.

See [save](#save-method-json-struct) for details.

# set_value method ([JSON](#struct-ipworksiotjson) Struct)

This method sets a new value for the element specified by XPath.

## Syntax

*Rust Syntax*

```text
fn set_value(&self, value : &str, value_type : i32) -> Result<(), IPWorksIoTError>
```

## Remarks

This method sets a new value for the element specified in [xpath](#xpath-property-json-struct). This is used to modify an existing JSON document.

*value* specifies the new value.

*value_type* specifies the type of the value. Possible values are as follows:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)

See [save](#save-method-json-struct) for details.

# start_array method ([JSON](#struct-ipworksiotjson) Struct)

This method writes the opening bracket of a JSON array.

## Syntax

*Rust Syntax*

```text
fn start_array(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method writes the opening bracket of a JSON array to the output. To close the array, call [end_array](#end_array-method-json-struct).

# start_object method ([JSON](#struct-ipworksiotjson) Struct)

This event writes the opening brace of a JSON object.

## Syntax

*Rust Syntax*

```text
fn start_object(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method writes the opening brace of a JSON object to the output. To close the object, call [end_object](#end_object-method-json-struct).

# try_xpath method ([JSON](#struct-ipworksiotjson) Struct)

This method navigates to the specified XPath if it exists.

## Syntax

*Rust Syntax*

```text
fn try_xpath(&self, xpath : &str) ->  Result<bool, IPWorksIoTError>
```

## Remarks

This method will attempt to navigate to the specified *xpath* parameter if it exists within the document.

If the XPath exists, the [xpath](#xpath-property-json-struct) property will be updated and this method returns *true*.

If the XPath does not exist, the [xpath](#xpath-property-json-struct) property is not updated and this method returns *false*.

# on_characters event ([JSON](#struct-ipworksiotjson) Struct)

This event is fired for plaintext segments of the input stream.

## Syntax

*Rust Syntax*

```text
// JSONCharactersEventArgs carries the JSON Characters event's parameters.
pub struct JSONCharactersEventArgs {
  fn text(&self) -> &String
}

// JSONCharactersEvent defines the signature of the JSON Characters event's handler function.
pub trait JSONCharactersEvent {
  fn on_characters(&self, sender : JSON, e : &mut JSONCharactersEventArgs);
}

impl <'a> JSON<'a> {
  pub fn on_characters(&self) -> &'a dyn JSONCharactersEvent;
  pub fn set_on_characters(&mut self, value : &'a dyn JSONCharactersEvent);
  ...
}
```

## Remarks

The on_characters event provides the plaintext content of the JSON document (i.e., the text inside the elements). The text is provided through the *text* parameter.

The text includes white space as well as end-of-line characters, except for ignorable whitespace, which is fired through the [on_ignorable_whitespace](#on_ignorable_whitespace-event-json-struct) event.

# on_end_document event ([JSON](#struct-ipworksiotjson) Struct)

This event fires when the end of a JSON document is encountered.

## Syntax

*Rust Syntax*

```text
// JSONEndDocumentEventArgs carries the JSON EndDocument event's parameters.
pub struct JSONEndDocumentEventArgs {
}

// JSONEndDocumentEvent defines the signature of the JSON EndDocument event's handler function.
pub trait JSONEndDocumentEvent {
  fn on_end_document(&self, sender : JSON, e : &mut JSONEndDocumentEventArgs);
}

impl <'a> JSON<'a> {
  pub fn on_end_document(&self) -> &'a dyn JSONEndDocumentEvent;
  pub fn set_on_end_document(&mut self, value : &'a dyn JSONEndDocumentEvent);
  ...
}
```

## Remarks

This event fires when parsing of a JSON document ends. This event may fire multiple times if [InputFormat](#InputFormat) is set to a value that accepts multiple JSON documents.

# on_end_element event ([JSON](#struct-ipworksiotjson) Struct)

This event is fired when an end-element tag is encountered.

## Syntax

*Rust Syntax*

```text
// JSONEndElementEventArgs carries the JSON EndElement event's parameters.
pub struct JSONEndElementEventArgs {
  fn element(&self) -> &String
}

// JSONEndElementEvent defines the signature of the JSON EndElement event's handler function.
pub trait JSONEndElementEvent {
  fn on_end_element(&self, sender : JSON, e : &mut JSONEndElementEventArgs);
}

impl <'a> JSON<'a> {
  pub fn on_end_element(&self) -> &'a dyn JSONEndElementEvent;
  pub fn set_on_end_element(&mut self, value : &'a dyn JSONEndElementEvent);
  ...
}
```

## Remarks

The on_end_element event is fired when the end of an element is found in the document.

The element name is provided by the *element* parameter.

# on_error event ([JSON](#struct-ipworksiotjson) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// JSONErrorEventArgs carries the JSON Error event's parameters.
pub struct JSONErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// JSONErrorEvent defines the signature of the JSON Error event's handler function.
pub trait JSONErrorEvent {
  fn on_error(&self, sender : JSON, e : &mut JSONErrorEventArgs);
}

impl <'a> JSON<'a> {
  pub fn on_error(&self) -> &'a dyn JSONErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn JSONErrorEvent);
  ...
}
```

## Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The *error_code* parameter contains an error code, and the *description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-json-struct) section.

# on_ignorable_whitespace event ([JSON](#struct-ipworksiotjson) Struct)

This event is fired when a section of ignorable whitespace is encountered.

## Syntax

*Rust Syntax*

```text
// JSONIgnorableWhitespaceEventArgs carries the JSON IgnorableWhitespace event's parameters.
pub struct JSONIgnorableWhitespaceEventArgs {
  fn text(&self) -> &String
}

// JSONIgnorableWhitespaceEvent defines the signature of the JSON IgnorableWhitespace event's handler function.
pub trait JSONIgnorableWhitespaceEvent {
  fn on_ignorable_whitespace(&self, sender : JSON, e : &mut JSONIgnorableWhitespaceEventArgs);
}

impl <'a> JSON<'a> {
  pub fn on_ignorable_whitespace(&self) -> &'a dyn JSONIgnorableWhitespaceEvent;
  pub fn set_on_ignorable_whitespace(&mut self, value : &'a dyn JSONIgnorableWhitespaceEvent);
  ...
}
```

## Remarks

The ignorable whitespace section is provided by the *text* parameter.

# on_json event ([JSON](#struct-ipworksiotjson) Struct)

This event fires with the JSON data being written.

## Syntax

*Rust Syntax*

```text
// JSONJSONEventArgs carries the JSON JSON event's parameters.
pub struct JSONJSONEventArgs {
  fn text(&self) -> &String
}

// JSONJSONEvent defines the signature of the JSON JSON event's handler function.
pub trait JSONJSONEvent {
  fn on_json(&self, sender : JSON, e : &mut JSONJSONEventArgs);
}

impl <'a> JSON<'a> {
  pub fn on_json(&self) -> &'a dyn JSONJSONEvent;
  pub fn set_on_json(&mut self, value : &'a dyn JSONJSONEvent);
  ...
}
```

## Remarks

This event fires when output data are written.

*text* contains the JSON data currently being written.

# on_start_document event ([JSON](#struct-ipworksiotjson) Struct)

This event fires when the start of a new JSON document is encountered.

## Syntax

*Rust Syntax*

```text
// JSONStartDocumentEventArgs carries the JSON StartDocument event's parameters.
pub struct JSONStartDocumentEventArgs {
}

// JSONStartDocumentEvent defines the signature of the JSON StartDocument event's handler function.
pub trait JSONStartDocumentEvent {
  fn on_start_document(&self, sender : JSON, e : &mut JSONStartDocumentEventArgs);
}

impl <'a> JSON<'a> {
  pub fn on_start_document(&self) -> &'a dyn JSONStartDocumentEvent;
  pub fn set_on_start_document(&mut self, value : &'a dyn JSONStartDocumentEvent);
  ...
}
```

## Remarks

This event fires when parsing of a JSON document begins. This event may fire multiple times if [InputFormat](#InputFormat) is set to a value that accepts multiple JSON documents.

# on_start_element event ([JSON](#struct-ipworksiotjson) Struct)

This event is fired when a new element is encountered in the document.

## Syntax

*Rust Syntax*

```text
// JSONStartElementEventArgs carries the JSON StartElement event's parameters.
pub struct JSONStartElementEventArgs {
  fn element(&self) -> &String
}

// JSONStartElementEvent defines the signature of the JSON StartElement event's handler function.
pub trait JSONStartElementEvent {
  fn on_start_element(&self, sender : JSON, e : &mut JSONStartElementEventArgs);
}

impl <'a> JSON<'a> {
  pub fn on_start_element(&self) -> &'a dyn JSONStartElementEvent;
  pub fn set_on_start_element(&mut self, value : &'a dyn JSONStartElementEvent);
  ...
}
```

## Remarks

The on_start_element event is fired when a new element is found in the document.

The element name is provided through the *element* parameter.

# Config Settings ([JSON](#struct-ipworksiotjson) Struct)

 The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [config](#config-method-json-struct) method.

### JSON Config Settings

**CacheContent**: If true, the original JSON is stored internally in a buffer.This configuration setting controls whether the struct retains the entire original JSON data in memory (default: *true*). The cached data is used by the [xsub_tree](#xsub_tree-property-json-struct) property to return position-based subtrees from the original JSON. When CacheContents is disabled, this cached data is cleared to reduce memory usage when processing large JSON files, and XSubTree always returns an empty string as a result. Other X* properties rely on the internal [build_dom](#build_dom-property-json-struct) representation and are not affected by this setting.

**ElementXPath**: The XPath value for the current element in the document.This configuration setting holds the current XPath value when the document is parsed. When queried from inside the [on_start_element](#on_start_element-event-json-struct) event, the corresponding element's XPath value will be returned. For instance:

```csharp
string elementXPath = json.Config("ElementXPath");
```

NOTE: The [build_dom](#build_dom-property-json-struct) property must be set to *False*.

**EscapeForwardSlashes**: Whether to escape forward slashes when writing a JSON object.This configuration setting specifies whether forward slashes (*/*) are escaped when creating a JSON object using the struct. This does not affect parsing of JSON. It is applicable only when JSON values are written.

**InputFormat**: Specifies the input format used in JSON streaming.This configuration setting specifies how JSON documents are formatted as they are input to the struct. This setting is designed for use when data are provided via JSON streaming. This means multiple documents may be parsed by the struct. This setting is applicable only when [build_dom](#build_dom-property-json-struct) is set to False. Possible values are as follows:

| Value | Description |
| --- | --- |
| 0 (None - default) | Only a single JSON document is expected. Use this when a single JSON document is being parsed (most cases). |
| 1 (Line Delimited) | Multiple documents are separated by carriage return (CR), line feed (LF), or CRLF character sequences. |
| 2 (Record Separated) | A defined start and end delimiter separate documents. See [RecordStartDelimiter](#RecordStartDelimiter) and [RecordEndDelimiter](#RecordEndDelimiter). |
| 3 (Concatenated) | New documents begin immediately after the previous documents end; no characters or delimiters separate the documents. |

**PrettyPrint**: Determines whether output is on one line or "pretty printed".The value of this configuration setting determines whether output is generated as a single line of JSON or as multiple "pretty printed" lines. The following example code, provides a better understanding of this configuration setting:

```csharp
json.Config("PrettyPrint=true"); // false
json.StartObject();
json.PutName("data");
json.StartObject();
json.PutProperty("id", "3", 3);
json.PutProperty("first_name", "Emma", 2);
json.PutProperty("last_name", "Wong", 2);
json.PutProperty("avatar", "https://s3.amazonaws.com/uifaces/faces/twitter/olegpogodaev/128.jpg", 2);
json.EndObject();
json.EndObject();
json.Flush();
Console.WriteLine(json.OutputData);
```

 With PrettyPrint set to False (the default), the output would look like this:

```text
{"data":{"id":3,"first_name":"Emma","last_name":"Wong","avatar":"https:\/\/s3.amazonaws.com\/uifaces\/faces\/twitter\/olegpogodaev\/128.jpg"}}
```

 With PrettyPrint set to True, the output instead would look like this:

```text
{
  "data": {
    "id": 3,
    "first_name": "Emma",
    "last_name": "Wong",
    "avatar": "https:\/\/s3.amazonaws.com\/uifaces\/faces\/twitter\/olegpogodaev\/128.jpg"
  }
}
```

 The default value is False.

**RecordEndDelimiter**: The character sequence after the end of a JSON document.This configuration setting is used in conjunction with [InputFormat](#InputFormat) to specify the character sequence that is expected after the end of a JSON document.

**RecordStartDelimiter**: The character sequence before the start of a JSON document.This configuration setting is used in conjunction with [InputFormat](#InputFormat) to specify the character sequence that is expected before the start of a JSON document.

**StringProcessingOptions**: Defines options to use when processing string values.This configuration setting determines what additional processing is performed on string values during parsing. By default, no additional processing is performed and the string is returned as is from the document. Strings also may be unquoted, unescaped, or both. Possible values follow:

|  |  |
| --- | --- |
| 0 (none - default) | No additional processing is performed. |
| 1 (unquote) | Strings are unquoted. |
| 2 (unescape) | Any escaped sequences are unescaped. |
| 3 (unquote and unescape) | Values are both unquoted and unescaped. |

 For instance, given the JSON element:

```text
"example" : "value\ntest"
```

 The following table shows the resulting value for the XText of the element:

```text
"value\ntest"
```

```text
value\ntest
```

```text
"value
test"
```

```text
value
test
```

| StringProcessingOption | Output |
| --- | --- |
| 0 (none) |  |
| 1 (unquote) |  |
| 2 (unescape) |  |
| 3 (unquote and unescape) |  |

**XPathNotation**: Specifies the expected format when setting XPath.This configuration setting optionally specifies the expected input format when setting [xpath](#xpath-property-json-struct). Possible values follow:

- 0 (Auto - default)
- 1 (XPath)
- 2 (JSONPath)

 In most cases, the default of 0 (Auto) is sufficient. The struct will determine whether the path value is in XPath or JSONPath format automatically. If desired, the type may be explicitly set to either XPath or JSONPath using the values above.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([JSON](#struct-ipworksiotjson) Struct)

### JSON Errors

|  |  |
| --- | --- |
| 10231 | Unbalanced element tag. |
| 10232 | Invalid JSON markup. |
| 10233 | Invalid XPath. |
| 10234 | DOM tree unavailable (set BuildDOM to True and reparse). |

### XML Errors

|  |  |
| --- | --- |
| 101 | Invalid attribute index. |
| 102 | No attributes available. |
| 103 | Invalid namespace index. |
| 104 | No namespaces available. |
| 105 | Invalid element index. |
| 106 | No elements available. |
| 107 | Attribute does not exist. |
| 201 | Unbalanced element tag. |
| 202 | Unknown element prefix (cannot find namespace). |
| 203 | Unknown attribute prefix (cannot find namespace). |
| 204 | Invalid XML markup. |
| 205 | Invalid end state for parser. |
| 206 | Document contains unbalanced elements. |
| 207 | Invalid [xpath](#xpath-property-json-struct). |
| 208 | No such child. |
| 209 | Top element does not match start of path. |
| 210 | DOM tree unavailable (set [build_dom](#build_dom-property-json-struct) to true and reparse). |
| 302 | Cannot open file. |
| 401 | Invalid XML would be generated. |
| 402 | An invalid XML name has been specified. |