## Overview

This module provides APIs to perform conversions between XML and JSON/Ballerina records. It provides APIs to get natural representations of data in XML from JSON and to get JSON or Ballerina records data from natural representations of data in XML.

For information on the operations, which you can perform with the `xmldata` module, see the below **Functions**.


Represents the error type of the ballerina/xmldata module. This error type represents any error that can occur
during the execution of xmldata APIs.


Error

Converts a JSON object to an XML representation.
```ballerina
json data = {
    name: "John",
    age: 30
};
xml? xmlValue = check xmldata:fromJson(data);
```



fromJson

jsonValue

json

The `xmldata:JsonOptions` record for JSON to XML conversion properties


options

JsonOptions

XML representation of the given JSON if the JSON is
successfully converted or else an `xmldata:Error`


Converts an XML object to its JSON representation.
```ballerina
xml xmlValue = xml `` + xml `<name>supun</name>`;
json jsonValue = check xmldata:toJson(xmlValue);
```

toJson

xmlValue

The `xmldata:XmlOptions` record consisting of the configurations for the conversion


XmlOptions

The JSON representation of the given XML on success, else returns an `xmldata:Error`


Converts an XML to its Record representation.
```ballerina
type Person record {
    string name;
};
xml xmlValue = xml `` + xml `<name>Alex</name>`;
Person|xmldata:Error person = xmldata:toRecord(xmlValue);
```

toRecord

The XML source to be converted to a Record


Instructs whether to preserve the namespaces of the XML when converting


preserveNamespaces

boolean

The `typedesc` of the record that should be returned as a result


returnType

The Record representation of the given XML on success, else returns an `xmldata:Error`


Represents a record type to provide configurations for the JSON to XML
conversion.



The attribute prefix to use in the XML representation


attributePrefix

string

The XML tag to add an element from a JSON array


arrayEntryTag

Provides configurations for converting XML to JSON.



This module provides APIs to perform conversions between XML and JSON/Ballerina records. It provides APIs to get natural representations of data in XML from JSON and to get JSON or Ballerina records data from natural representations of data in XML.


Record: JsonOptions

Fields